sysnet-taxonomy


Namesysnet-taxonomy JSON
Version 1.0.0.4 PyPI version JSON
download
home_page
SummarySYSNET CITES Taxonomy REST API client
upload_time2023-08-29 16:24:02
maintainer
docs_urlNone
author
requires_python>=3.9
license
keywords swagger api pro taxonomii cites
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # sysnet-taxonomy
Toto je API pro taxonomii CITES

This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0.0
- Package version: 1.0.0.004
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on Github, you can install directly from Github

```sh
pip install sysnet-taxonomy
```

Then import the package:
```python
import taxonomy 
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python
from __future__ import print_function
import time
import taxonomy
from taxonomy.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
configuration = taxonomy.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = taxonomy.AdminsApi(taxonomy.ApiClient(configuration))
body = taxonomy.TaxonType() # TaxonType | Taxon item to add or update

try:
    # přidá nový taxon
    api_response = api_instance.add_taxon(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminsApi->add_taxon: %s\n" % e)

# Configure API key authorization: apiKey
configuration = taxonomy.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = taxonomy.AdminsApi(taxonomy.ApiClient(configuration))
identifier = 'identifier_example' # str | PID nebo celý vědecký název taxonu

try:
    # odstraní existující taxon
    api_instance.delete_taxon(identifier)
except ApiException as e:
    print("Exception when calling AdminsApi->delete_taxon: %s\n" % e)

# Configure API key authorization: apiKey
configuration = taxonomy.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = taxonomy.AdminsApi(taxonomy.ApiClient(configuration))
body = taxonomy.TaxonType() # TaxonType | Taxon item to add or update
identifier = 'identifier_example' # str | PID nebo celý vědecký název taxonu

try:
    # upraví existující taxon
    api_instance.put_taxon(body, identifier)
except ApiException as e:
    print("Exception when calling AdminsApi->put_taxon: %s\n" % e)
```

## Documentation for API Endpoints

All URIs are relative to *https://service.sysnet.cz/taxonomy/1.0.0*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AdminsApi* | [**add_taxon**](docs/AdminsApi.md#add_taxon) | **POST** /taxon | přidá nový taxon
*AdminsApi* | [**delete_taxon**](docs/AdminsApi.md#delete_taxon) | **DELETE** /taxon/{identifier} | odstraní existující taxon
*AdminsApi* | [**put_taxon**](docs/AdminsApi.md#put_taxon) | **PUT** /taxon/{identifier} | upraví existující taxon
*DevelopersApi* | [**info_api**](docs/DevelopersApi.md#info_api) | **GET** /info | vrací servisní informace
*DevelopersApi* | [**info_api_head**](docs/DevelopersApi.md#info_api_head) | **HEAD** /info | vrací informaci o dostupnosti služby
*PublicApi* | [**get_taxon**](docs/PublicApi.md#get_taxon) | **GET** /taxon/{identifier} | Vrátí konkrétní taxon
*PublicApi* | [**search_taxons**](docs/PublicApi.md#search_taxons) | **GET** /taxon | Vrátí seznam taxonů pro pohled nebo výběr

## Documentation For Models

 - [AdditionalType](docs/AdditionalType.md)
 - [ErrorModel](docs/ErrorModel.md)
 - [HybridType](docs/HybridType.md)
 - [TaxonEntryListType](docs/TaxonEntryListType.md)
 - [TaxonEntryType](docs/TaxonEntryType.md)
 - [TaxonType](docs/TaxonType.md)

## Documentation For Authorization


## apiKey

- **Type**: API key
- **API key parameter name**: X-API-KEY
- **Location**: HTTP header


## Author

rjaeger@sysnet.cz

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "sysnet-taxonomy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "Swagger,API pro taxonomii CITES",
    "author": "",
    "author_email": "Radim Jaeger <rjaeger@sysnet.cz>",
    "download_url": "https://files.pythonhosted.org/packages/38/f1/62b60a440f15b9f9320d55b48dd8a4efd6d40b644df04c030f18c4f1ca2b/sysnet-taxonomy-1.0.0.4.tar.gz",
    "platform": null,
    "description": "# sysnet-taxonomy\r\nToto je API pro taxonomii CITES\r\n\r\nThis Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\r\n\r\n- API version: 1.0.0\r\n- Package version: 1.0.0.004\r\n- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen\r\n\r\n## Requirements.\r\n\r\nPython 3.9+\r\n\r\n## Installation & Usage\r\n### pip install\r\n\r\nIf the python package is hosted on Github, you can install directly from Github\r\n\r\n```sh\r\npip install sysnet-taxonomy\r\n```\r\n\r\nThen import the package:\r\n```python\r\nimport taxonomy \r\n```\r\n\r\n## Getting Started\r\n\r\nPlease follow the [installation procedure](#installation--usage) and then run the following:\r\n\r\n```python\r\nfrom __future__ import print_function\r\nimport time\r\nimport taxonomy\r\nfrom taxonomy.rest import ApiException\r\nfrom pprint import pprint\r\n\r\n# Configure API key authorization: apiKey\r\nconfiguration = taxonomy.Configuration()\r\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\r\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\r\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\r\n\r\n# create an instance of the API class\r\napi_instance = taxonomy.AdminsApi(taxonomy.ApiClient(configuration))\r\nbody = taxonomy.TaxonType() # TaxonType | Taxon item to add or update\r\n\r\ntry:\r\n    # p\u0159id\u00e1 nov\u00fd taxon\r\n    api_response = api_instance.add_taxon(body)\r\n    pprint(api_response)\r\nexcept ApiException as e:\r\n    print(\"Exception when calling AdminsApi->add_taxon: %s\\n\" % e)\r\n\r\n# Configure API key authorization: apiKey\r\nconfiguration = taxonomy.Configuration()\r\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\r\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\r\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\r\n\r\n# create an instance of the API class\r\napi_instance = taxonomy.AdminsApi(taxonomy.ApiClient(configuration))\r\nidentifier = 'identifier_example' # str | PID nebo cel\u00fd v\u011bdeck\u00fd n\u00e1zev taxonu\r\n\r\ntry:\r\n    # odstran\u00ed existuj\u00edc\u00ed taxon\r\n    api_instance.delete_taxon(identifier)\r\nexcept ApiException as e:\r\n    print(\"Exception when calling AdminsApi->delete_taxon: %s\\n\" % e)\r\n\r\n# Configure API key authorization: apiKey\r\nconfiguration = taxonomy.Configuration()\r\nconfiguration.api_key['X-API-KEY'] = 'YOUR_API_KEY'\r\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\r\n# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'\r\n\r\n# create an instance of the API class\r\napi_instance = taxonomy.AdminsApi(taxonomy.ApiClient(configuration))\r\nbody = taxonomy.TaxonType() # TaxonType | Taxon item to add or update\r\nidentifier = 'identifier_example' # str | PID nebo cel\u00fd v\u011bdeck\u00fd n\u00e1zev taxonu\r\n\r\ntry:\r\n    # uprav\u00ed existuj\u00edc\u00ed taxon\r\n    api_instance.put_taxon(body, identifier)\r\nexcept ApiException as e:\r\n    print(\"Exception when calling AdminsApi->put_taxon: %s\\n\" % e)\r\n```\r\n\r\n## Documentation for API Endpoints\r\n\r\nAll URIs are relative to *https://service.sysnet.cz/taxonomy/1.0.0*\r\n\r\nClass | Method | HTTP request | Description\r\n------------ | ------------- | ------------- | -------------\r\n*AdminsApi* | [**add_taxon**](docs/AdminsApi.md#add_taxon) | **POST** /taxon | p\u0159id\u00e1 nov\u00fd taxon\r\n*AdminsApi* | [**delete_taxon**](docs/AdminsApi.md#delete_taxon) | **DELETE** /taxon/{identifier} | odstran\u00ed existuj\u00edc\u00ed taxon\r\n*AdminsApi* | [**put_taxon**](docs/AdminsApi.md#put_taxon) | **PUT** /taxon/{identifier} | uprav\u00ed existuj\u00edc\u00ed taxon\r\n*DevelopersApi* | [**info_api**](docs/DevelopersApi.md#info_api) | **GET** /info | vrac\u00ed servisn\u00ed informace\r\n*DevelopersApi* | [**info_api_head**](docs/DevelopersApi.md#info_api_head) | **HEAD** /info | vrac\u00ed informaci o dostupnosti slu\u017eby\r\n*PublicApi* | [**get_taxon**](docs/PublicApi.md#get_taxon) | **GET** /taxon/{identifier} | Vr\u00e1t\u00ed konkr\u00e9tn\u00ed taxon\r\n*PublicApi* | [**search_taxons**](docs/PublicApi.md#search_taxons) | **GET** /taxon | Vr\u00e1t\u00ed seznam taxon\u016f pro pohled nebo v\u00fdb\u011br\r\n\r\n## Documentation For Models\r\n\r\n - [AdditionalType](docs/AdditionalType.md)\r\n - [ErrorModel](docs/ErrorModel.md)\r\n - [HybridType](docs/HybridType.md)\r\n - [TaxonEntryListType](docs/TaxonEntryListType.md)\r\n - [TaxonEntryType](docs/TaxonEntryType.md)\r\n - [TaxonType](docs/TaxonType.md)\r\n\r\n## Documentation For Authorization\r\n\r\n\r\n## apiKey\r\n\r\n- **Type**: API key\r\n- **API key parameter name**: X-API-KEY\r\n- **Location**: HTTP header\r\n\r\n\r\n## Author\r\n\r\nrjaeger@sysnet.cz\r\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "SYSNET CITES Taxonomy REST API client",
    "version": "1.0.0.4",
    "project_urls": {
        "Homepage": "https://github.com/SYSNET-CZ/swagger/tree/main/clients/taxonomy"
    },
    "split_keywords": [
        "swagger",
        "api pro taxonomii cites"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fa841a7465bff586ab72c647c4aee28943e2c19da3846a9f0010e5e0237c1979",
                "md5": "f9bdd1f25a1ce389e8a602a40f22d117",
                "sha256": "4c3e6bc4208c8814461688addc78d7bdcc6a7ce5e5d461e69c0110a70292bf9c"
            },
            "downloads": -1,
            "filename": "sysnet_taxonomy-1.0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f9bdd1f25a1ce389e8a602a40f22d117",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 38037,
            "upload_time": "2023-08-29T16:24:00",
            "upload_time_iso_8601": "2023-08-29T16:24:00.354851Z",
            "url": "https://files.pythonhosted.org/packages/fa/84/1a7465bff586ab72c647c4aee28943e2c19da3846a9f0010e5e0237c1979/sysnet_taxonomy-1.0.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "38f162b60a440f15b9f9320d55b48dd8a4efd6d40b644df04c030f18c4f1ca2b",
                "md5": "aed5d562d9b3279784f508f0cb08ed33",
                "sha256": "e00961a2ef32f4fbc666e8cbbca20f7a165f772ae4094093c1111dffe2281749"
            },
            "downloads": -1,
            "filename": "sysnet-taxonomy-1.0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "aed5d562d9b3279784f508f0cb08ed33",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 23229,
            "upload_time": "2023-08-29T16:24:02",
            "upload_time_iso_8601": "2023-08-29T16:24:02.371873Z",
            "url": "https://files.pythonhosted.org/packages/38/f1/62b60a440f15b9f9320d55b48dd8a4efd6d40b644df04c030f18c4f1ca2b/sysnet-taxonomy-1.0.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-29 16:24:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "SYSNET-CZ",
    "github_project": "swagger",
    "github_not_found": true,
    "lcname": "sysnet-taxonomy"
}
        
Elapsed time: 0.11896s