{"id":28644953,"url":"https://github.com/vliz-be-opsci/py-sdn-cdi-client","last_synced_at":"2025-08-02T11:32:51.410Z","repository":{"id":50307411,"uuid":"518421155","full_name":"vliz-be-opsci/py-sdn-cdi-client","owner":"vliz-be-opsci","description":"Python client for the SDN API","archived":false,"fork":false,"pushed_at":"2022-09-13T14:10:20.000Z","size":262,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-09T10:45:13.497Z","etag":null,"topics":["openapi-client","package","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vliz-be-opsci.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/SecurityApi.md","support":null}},"created_at":"2022-07-27T10:59:01.000Z","updated_at":"2023-02-21T14:03:20.000Z","dependencies_parsed_at":"2023-01-18T06:15:49.946Z","dependency_job_id":null,"html_url":"https://github.com/vliz-be-opsci/py-sdn-cdi-client","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/vliz-be-opsci/py-sdn-cdi-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vliz-be-opsci%2Fpy-sdn-cdi-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vliz-be-opsci%2Fpy-sdn-cdi-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vliz-be-opsci%2Fpy-sdn-cdi-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vliz-be-opsci%2Fpy-sdn-cdi-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vliz-be-opsci","download_url":"https://codeload.github.com/vliz-be-opsci/py-sdn-cdi-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vliz-be-opsci%2Fpy-sdn-cdi-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268378965,"owners_count":24240907,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["openapi-client","package","python"],"created_at":"2025-06-13T00:31:03.369Z","updated_at":"2025-08-02T11:32:51.380Z","avatar_url":"https://github.com/vliz-be-opsci.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cdi-sdn-py\nA detailed description of the operation.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 5.1.0\n- Package version: 1.0.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython \u003e=3.6\n\n## Installation \u0026 Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport cdi_sdn_py\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport cdi_sdn_py\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport cdi_sdn_py\nfrom pprint import pprint\nfrom cdi_sdn_py.api import info_api\nfrom cdi_sdn_py.model.errors_return import ErrorsReturn\n# Defining the host is optional and defaults to https://seadatanet-buffer5.maris.nl/api_v5.1\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = cdi_sdn_py.Configuration(\n    host = \"https://seadatanet-buffer5.maris.nl/api_v5.1\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure Bearer authorization (bearerToken): bearerAuth\nconfiguration = cdi_sdn_py.Configuration(\n    access_token = 'YOUR_BEARER_TOKEN'\n)\n\n\n# Enter a context with an instance of the API client\nwith cdi_sdn_py.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = info_api.InfoApi(api_client)\n    output_type = \"html\" # str | \n\n    try:\n        # Reference_list\n        api_instance.reference_list_output_type_get(output_type)\n    except cdi_sdn_py.ApiException as e:\n        print(\"Exception when calling InfoApi-\u003ereference_list_output_type_get: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://seadatanet-buffer5.maris.nl/api_v5.1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*InfoApi* | [**reference_list_output_type_get**](docs/InfoApi.md#reference_list_output_type_get) | **GET** /reference_list/{outputType} | Reference_list\n*InfoApi* | [**status_get**](docs/InfoApi.md#status_get) | **GET** /status | Status\n*MetadataApi* | [**metadata_query_post**](docs/MetadataApi.md#metadata_query_post) | **POST** /metadata/query | Make a query and get the metadata back\n*OrdersApi* | [**order_download_csv_order_number_restriction_get**](docs/OrdersApi.md#order_download_csv_order_number_restriction_get) | **GET** /order/download/csv/{orderNumber}/{restriction} | Download metadata CSV for this order\n*OrdersApi* | [**order_order_number_get**](docs/OrdersApi.md#order_order_number_get) | **GET** /order/{orderNumber} | Find order by Ordernumber\n*OrdersApi* | [**order_query_post**](docs/OrdersApi.md#order_query_post) | **POST** /order/query | Make an order by query\n*OrdersApi* | [**orderlist_get**](docs/OrdersApi.md#orderlist_get) | **GET** /orderlist | Show all your relevant orders from 30 days or less\n*SecurityApi* | [**login_post**](docs/SecurityApi.md#login_post) | **POST** /login | Normal login\n\n\n## Documentation For Models\n\n - [ErrorsReturn](docs/ErrorsReturn.md)\n - [Login](docs/Login.md)\n - [LoginPost200Response](docs/LoginPost200Response.md)\n - [MetadataQuery](docs/MetadataQuery.md)\n - [MetadataQueryReturn](docs/MetadataQueryReturn.md)\n - [MetadataQueryReturnFacetSearchInner](docs/MetadataQueryReturnFacetSearchInner.md)\n - [MetadataQueryReturnFacetSearchInnerFacetField1](docs/MetadataQueryReturnFacetSearchInnerFacetField1.md)\n - [MetadataQueryReturnFacetSearchInnerFacetField1StepsInner](docs/MetadataQueryReturnFacetSearchInnerFacetField1StepsInner.md)\n - [MetadataQueryReturnResultInner](docs/MetadataQueryReturnResultInner.md)\n - [MetadataQueryReturnYouSearchForTranslationInner](docs/MetadataQueryReturnYouSearchForTranslationInner.md)\n - [MetadataQueryReturnYouSearchForTranslationInnerQueryField1](docs/MetadataQueryReturnYouSearchForTranslationInnerQueryField1.md)\n - [MetadataQueryReturnYouSearchForTranslationInnerQueryField2](docs/MetadataQueryReturnYouSearchForTranslationInnerQueryField2.md)\n - [OrderDetailsReturn](docs/OrderDetailsReturn.md)\n - [OrderDetailsReturnDownload](docs/OrderDetailsReturnDownload.md)\n - [OrderDetailsReturnDownloadCsv](docs/OrderDetailsReturnDownloadCsv.md)\n - [OrderDetailsReturnDownloadData](docs/OrderDetailsReturnDownloadData.md)\n - [OrderDetailsReturnDownloadDataUnrestricted](docs/OrderDetailsReturnDownloadDataUnrestricted.md)\n - [OrderListReturn](docs/OrderListReturn.md)\n - [OrderListReturnOrdersInner](docs/OrderListReturnOrdersInner.md)\n - [OrderListReturnOrdersInnerOrderNumber](docs/OrderListReturnOrdersInnerOrderNumber.md)\n - [OrderQuery](docs/OrderQuery.md)\n - [OrderQueryQueryFields](docs/OrderQueryQueryFields.md)\n - [OrderQueryReturn](docs/OrderQueryReturn.md)\n - [OrderQueryReturnWarnings](docs/OrderQueryReturnWarnings.md)\n\n\n## Documentation For Authorization\n\n\n## bearerAuth\n\n- **Type**: Bearer authentication (bearerToken)\n\n\n## Author\n\ninfo@maris.nl\n\n\n## Notes for Large OpenAPI documents\nIf the OpenAPI document is large, imports in cdi_sdn_py.apis and cdi_sdn_py.models may fail with a\nRecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:\n\nSolution 1:\nUse specific imports for apis and models like:\n- `from cdi_sdn_py.api.default_api import DefaultApi`\n- `from cdi_sdn_py.model.pet import Pet`\n\nSolution 2:\nBefore importing the package, adjust the maximum recursion limit as shown below:\n```\nimport sys\nsys.setrecursionlimit(1500)\nimport cdi_sdn_py\nfrom cdi_sdn_py.apis import *\nfrom cdi_sdn_py.models import *\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvliz-be-opsci%2Fpy-sdn-cdi-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvliz-be-opsci%2Fpy-sdn-cdi-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvliz-be-opsci%2Fpy-sdn-cdi-client/lists"}