isogeo-pysdk


Nameisogeo-pysdk JSON
Version 3.8.0 PyPI version JSON
download
home_pagehttps://github.com/isogeo/isogeo-api-py-minsdk/
SummaryAPI wrapper for the Isogeo REST API
upload_time2022-12-05 16:25:12
maintainer
docs_urlNone
authorIsogeo
requires_python>=3.7, <4
licenseLGPL3
keywords gis metadata inspire isogeo api rest geographical data iso19139
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # Isogeo API Python SDK

![PyPI](https://img.shields.io/pypi/v/isogeo-pysdk.svg?style=flat-square) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/isogeo-pysdk?style=flat-square)

[![Build Status](https://dev.azure.com/isogeo/Python%20SDK/_apis/build/status/isogeo.isogeo-api-py-minsdk?branchName=master)](https://dev.azure.com/isogeo/Python%20SDK/_build/latest?definitionId=3&branchName=master)
![Azure DevOps coverage](https://img.shields.io/azure-devops/coverage/isogeo/Python%20SDK/3?style=flat-square)

[![Documentation Status](https://readthedocs.org/projects/isogeo-api-pysdk/badge/?version=latest)](https://isogeo-api-pysdk.readthedocs.io/en/latest/?badge=latest) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

A Python package to use Isogeo REST API.

## Requirements

Isogeo API requires oAuth2 authentication. To obtain credentials, send us your request by email [projects+api@isogeo.com](mailto:projects+api@isogeo.com).

Based on the well known [`requests`](https://github.com/requests/requests) package and the extension [`requests-oauthlib`](https://github.com/requests/requests-oauthlib).

## Documentation

- [Package manual and autogenerated modules doc](https://isogeo-api-pysdk.readthedocs.io)
- [Isogeo API](http://help.isogeo.com/api/)
- [Contribution guidelines (FR)](https://github.com/isogeo/isogeo-api-py-minsdk/wiki/)

## Usage in a nutshell

```powershell
python -m pip install --user isogeo-pysdk
# or using pipenv
python -m pipenv install isogeo-pysdk
```

### Quickstart

```python
from isogeo_pysdk import Isogeo

# authenticate your client application
isogeo = Isogeo(client_id=app_id,
                client_secret=app_secret)

# get the token
isogeo.connect()

# search within catalogs shared to the application
search = isogeo.search()

# print some statements
print("Search query parameters: ", search.query)
print("Total count of metadatas shared: ", search.total)
print("Count of resources got by request: {}\n".format(len(search.results)))

# close the session when you finish
isogeo.close()
```

Samples are available in `the source repository <https://github.com/isogeo/isogeo-api-py-minsdk/tree/master/isogeo_pysdk/samples>`_.

### Tests

Tests are performed for each published commit:

- by [Azure Pipelines](https://dev.azure.com/isogeo/Python%20SDK/_build)

```powershell
python -m pip install --upgrade -r tests/requirements_test.txt
python -m pytest
```

Or using the [included Powershell script](https://github.com/isogeo/isogeo-api-py-minsdk/blob/master/tool_test_coverage.ps1):

```powershell
.\tool_test_coverage.ps1
```

### Build

To package and upload:

```powershell
.\tool_build_upload.ps1
```

To build docs:

```powershell
.\tool_docs_build.ps1
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/isogeo/isogeo-api-py-minsdk/",
    "name": "isogeo-pysdk",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7, <4",
    "maintainer_email": "",
    "keywords": "GIS metadata INSPIRE Isogeo API REST geographical data ISO19139",
    "author": "Isogeo",
    "author_email": "contact@isogeo.com",
    "download_url": "https://files.pythonhosted.org/packages/6f/b9/9010ad07ddb6f7406ef5e89e206a25122052aa8e559c5d3c35b8b295a180/isogeo-pysdk-3.8.0.tar.gz",
    "platform": null,
    "description": "# Isogeo API Python SDK\r\n\r\n![PyPI](https://img.shields.io/pypi/v/isogeo-pysdk.svg?style=flat-square) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/isogeo-pysdk?style=flat-square)\r\n\r\n[![Build Status](https://dev.azure.com/isogeo/Python%20SDK/_apis/build/status/isogeo.isogeo-api-py-minsdk?branchName=master)](https://dev.azure.com/isogeo/Python%20SDK/_build/latest?definitionId=3&branchName=master)\r\n![Azure DevOps coverage](https://img.shields.io/azure-devops/coverage/isogeo/Python%20SDK/3?style=flat-square)\r\n\r\n[![Documentation Status](https://readthedocs.org/projects/isogeo-api-pysdk/badge/?version=latest)](https://isogeo-api-pysdk.readthedocs.io/en/latest/?badge=latest) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\r\n\r\nA Python package to use Isogeo REST API.\r\n\r\n## Requirements\r\n\r\nIsogeo API requires oAuth2 authentication. To obtain credentials, send us your request by email [projects+api@isogeo.com](mailto:projects+api@isogeo.com).\r\n\r\nBased on the well known [`requests`](https://github.com/requests/requests) package and the extension [`requests-oauthlib`](https://github.com/requests/requests-oauthlib).\r\n\r\n## Documentation\r\n\r\n- [Package manual and autogenerated modules doc](https://isogeo-api-pysdk.readthedocs.io)\r\n- [Isogeo API](http://help.isogeo.com/api/)\r\n- [Contribution guidelines (FR)](https://github.com/isogeo/isogeo-api-py-minsdk/wiki/)\r\n\r\n## Usage in a nutshell\r\n\r\n```powershell\r\npython -m pip install --user isogeo-pysdk\r\n# or using pipenv\r\npython -m pipenv install isogeo-pysdk\r\n```\r\n\r\n### Quickstart\r\n\r\n```python\r\nfrom isogeo_pysdk import Isogeo\r\n\r\n# authenticate your client application\r\nisogeo = Isogeo(client_id=app_id,\r\n                client_secret=app_secret)\r\n\r\n# get the token\r\nisogeo.connect()\r\n\r\n# search within catalogs shared to the application\r\nsearch = isogeo.search()\r\n\r\n# print some statements\r\nprint(\"Search query parameters: \", search.query)\r\nprint(\"Total count of metadatas shared: \", search.total)\r\nprint(\"Count of resources got by request: {}\\n\".format(len(search.results)))\r\n\r\n# close the session when you finish\r\nisogeo.close()\r\n```\r\n\r\nSamples are available in `the source repository <https://github.com/isogeo/isogeo-api-py-minsdk/tree/master/isogeo_pysdk/samples>`_.\r\n\r\n### Tests\r\n\r\nTests are performed for each published commit:\r\n\r\n- by [Azure Pipelines](https://dev.azure.com/isogeo/Python%20SDK/_build)\r\n\r\n```powershell\r\npython -m pip install --upgrade -r tests/requirements_test.txt\r\npython -m pytest\r\n```\r\n\r\nOr using the [included Powershell script](https://github.com/isogeo/isogeo-api-py-minsdk/blob/master/tool_test_coverage.ps1):\r\n\r\n```powershell\r\n.\\tool_test_coverage.ps1\r\n```\r\n\r\n### Build\r\n\r\nTo package and upload:\r\n\r\n```powershell\r\n.\\tool_build_upload.ps1\r\n```\r\n\r\nTo build docs:\r\n\r\n```powershell\r\n.\\tool_docs_build.ps1\r\n```\r\n",
    "bugtrack_url": null,
    "license": "LGPL3",
    "summary": "API wrapper for the Isogeo REST API",
    "version": "3.8.0",
    "split_keywords": [
        "gis",
        "metadata",
        "inspire",
        "isogeo",
        "api",
        "rest",
        "geographical",
        "data",
        "iso19139"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "dd940f526db588f116f4ce13c83e4fe8",
                "sha256": "e0a2607ada7205e6a6dac4e76ca6c390621238a1d540b9fc14e81d73ef097bf4"
            },
            "downloads": -1,
            "filename": "isogeo_pysdk-3.8.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "dd940f526db588f116f4ce13c83e4fe8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7, <4",
            "size": 221021,
            "upload_time": "2022-12-05T16:25:11",
            "upload_time_iso_8601": "2022-12-05T16:25:11.052489Z",
            "url": "https://files.pythonhosted.org/packages/c9/08/0f3b08e2ea7f28717a4af8b32bd4fc8133a0e0eefd74b3813fe04e33ae14/isogeo_pysdk-3.8.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "c58ef377ff5b75d029e5734d2ff751d2",
                "sha256": "a7e82f1d90d5ecd73f9f8f68e50227f3476dcfb46f29e789ad3f2302babaec07"
            },
            "downloads": -1,
            "filename": "isogeo-pysdk-3.8.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c58ef377ff5b75d029e5734d2ff751d2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7, <4",
            "size": 124069,
            "upload_time": "2022-12-05T16:25:12",
            "upload_time_iso_8601": "2022-12-05T16:25:12.740729Z",
            "url": "https://files.pythonhosted.org/packages/6f/b9/9010ad07ddb6f7406ef5e89e206a25122052aa8e559c5d3c35b8b295a180/isogeo-pysdk-3.8.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-05 16:25:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "isogeo",
    "github_project": "isogeo-api-py-minsdk",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [],
    "lcname": "isogeo-pysdk"
}
        
Elapsed time: 0.02896s