1- Python minimalist SDK to use Isogeo REST API
2- =============================================
1+ |Version | |Build_Status | |compat_py27 | |compat_py35 | |compat_py36 |
32
4- .. image :: https://badge.fury.io/py/isogeo-pysdk.svg
5- :target: https://badge.fury.io/py/isogeo-pysdk
6- :alt: PyPI version
7-
8- .. image :: https://img.shields.io/badge/python-2.7-blue.svg
9- :target: https://badge.fury.io/py/isogeo-pysdk
10- :alt: Python 2.7.x compatiblity
11-
12- .. image :: https://img.shields.io/badge/python-3.5-blue.svg
13- :target: https://badge.fury.io/py/isogeo-pysdk
14- :alt: Python 3.5.x compatiblity
15-
16- .. image :: https://img.shields.io/badge/python-3.6-blue.svg
17- :target: https://badge.fury.io/py/isogeo-pysdk
18- :alt: Python 3.6.x compatiblity
19-
20- .. image :: https://travis-ci.org/Guts/isogeo-api-py-minsdk.svg?branch=master
21- :target: https://travis-ci.org/Guts/isogeo-api-py-minsdk
22- :alt: Travis build status
3+ Isogeo API Python SDK
4+ =====================
235
6+ A Python package to use Isogeo REST API.
247
258Getting API keys
269================
2710
28- API keys are required to use it.
29- `Send us your request by email <mailto:projects+api@isogeo.com >`_.
11+ API keys are required to use it. `Send us your request by email <mailto:projects+api@isogeo.com >`_.
3012
3113Getting Help
32- ============
14+ ------------
3315
3416There is a basic documentation about the `Isogeo API <https://docs.google.com/document/d/11dayY1FH1NETn6mn9Pt2y3n8ywVUD0DoKbCi9ct9ZRo/edit?usp=sharing >`_.
3517
3618Installing
37- ==========
19+ ----------
3820
3921To use:
4022
41- .. code-block :: shell
23+ ::
4224
4325 pip install --user isogeo-pysdk
4426
4527For developers:
4628
47- .. code-block :: shell
29+ .. code-block :: console
4830
4931 git clone git@github.com:Guts/isogeo-api-py-minsdk.git
5032 cd isogeo-api-py-minsdk
5133 python setup.py install
5234
5335 Quickstart
54- ==========
36+ ----------
5537
5638.. code-block :: python
5739
@@ -61,7 +43,6 @@ Quickstart
6143 isogeo = Isogeo(client_id = app_id,
6244 client_secret = app_secret)
6345
64-
6546 # get the token
6647 token = isogeo.connect()
6748
@@ -79,18 +60,18 @@ Others samples are available in `the source repository <https://github.com/Guts/
7960
8061
8162Isogeo API coverage
82- ===================
63+ -------------------
8364
8465Authentication
85- ---------------
66+ --------------
8667
8768- [X] group application (oAuth2 Credentials Grant)
8869- [ ] user confidential application (oAuth2 Authorization Code Grant)
8970- [ ] user public application (oAuth2 Implicit Grant)
9071- [X] token auto refresh
9172
9273Resources search ( GET /resources/search )
93- -------------------------------------------
74+ ------------------------------------------
9475
9576Resources search parameters:
9677
@@ -109,7 +90,7 @@ Resources search parameters:
10990
11091
11192Resource details ( GET /resources/{rid} )
112- ----------------------------------------
93+ -----------------------------------------
11394
11495Resource detailed parameters:
11596
@@ -125,7 +106,7 @@ Others:
125106- [ ] resource with operations subresource included ( GET /resources/{rid}/operationds - only for services)
126107
127108Keyword details ( GET /keyword/{kid} )
128- ---------------------------------------
109+ --------------------------------------
129110
130111- [X] kid (keyword UUID)
131112- [X] _include (subresources management)
@@ -134,28 +115,28 @@ Keyword details ( GET /keyword/{kid} )
134115These requests are not publicly available.
135116
136117Thesaurus ( GET /thesauri )
137- ----------------------------------
118+ ---------------------------
138119
139120- [X] list of available thesauri
140121- [X] specific thesaurus ( GET /thesauri/tid )
141122- [X] searches for keywords in a specific thesaurus ( GET /thesauri/{tid}/keywords/search )
142123
143124Shares ( GET /shares )
144- ----------------------------------------------
125+ -----------------------
145126
146127- [X] list accessible shares
147128- [X] specific share ( GET /shares/sid )
148129
149130Licenses ( GET /licenses )
150- ----------------------------------------------
131+ ---------------------------
151132
152133- [X] list licenses of a workgroup
153134- [X] details on a specific license ( GET /license/lid )
154135
155136These requests are not publicly available.
156137
157138Miscellaneous & bonus
158- ----------------------
139+ ---------------------
159140
160141- [X] check API version
161142- [X] check database version
@@ -184,3 +165,34 @@ To run tests:
184165 pip install --upgrade -r tests/requirements_test.txt
185166 python setup.py install
186167 python -m unittest discover
168+
169+
170+ Build
171+ =====
172+
173+ To package and upload:
174+
175+ .. code-block :: powershell
176+
177+ .\build_upload.ps1
178+
179+
180+ .. |Version | image :: https://badge.fury.io/py/isogeo-pysdk.svg
181+ :target: https://badge.fury.io/py/isogeo-pysdk
182+ :alt: PyPI version
183+
184+ .. |Build_Status | image :: https://travis-ci.org/Guts/isogeo-api-py-minsdk.svg?branch=master
185+ :target: https://travis-ci.org/Guts/isogeo-api-py-minsdk
186+ :alt: Travis build status
187+
188+ .. |compat_py27 | image :: https://img.shields.io/badge/python-2.7-blue.svg
189+ :target: https://badge.fury.io/py/isogeo-pysdk
190+ :alt: Python 2.7.x compatiblity
191+
192+ .. |compat_py35 | image :: https://img.shields.io/badge/python-3.5-blue.svg
193+ :target: https://badge.fury.io/py/isogeo-pysdk
194+ :alt: Python 3.5.x compatiblity
195+
196+ .. |compat_py36 | image :: https://img.shields.io/badge/python-3.6-blue.svg
197+ :target: https://badge.fury.io/py/isogeo-pysdk
198+ :alt: Python 3.6.x compatiblity
0 commit comments