From 7c9a41df72a0a2610bb2ba76728c665af51e0ab8 Mon Sep 17 00:00:00 2001 From: Jonas Gunz Date: Wed, 13 Jan 2021 21:40:38 +0100 Subject: README --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e216806..59ba87c 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,6 @@ An incomplete phpIPAM API implementation in python. -Refer to the [API Doc](https://phpipam.net/api-documentation/) for data layout. - ``` import phpipam_api @@ -17,10 +15,13 @@ data = ipam..() ``` All functions return a dictionary object or a list of dictionary objects. +Refer to the [API Doc](https://phpipam.net/api-documentation/) for data layout. If an error is encountered, an exception is raised. ## Controllers +Functions shared by all controllers: + * `get()` returns all obejcts in in controller * `byID(object_id=)` get specific obejct by ID * `create(data=)` @@ -61,9 +62,9 @@ If an error is encountered, an exception is raised. ### prefix -requires +## requires - dateutil - requests +* `dateutil` +* `requests` License: MIT -- cgit v1.2.3