<p align="center">
<a href="https://dratio.io">
<img src="https://user-images.githubusercontent.com/16774925/184549419-b05ebfd2-436e-41e2-9172-a05d53e67c1d.svg">
</a>
</p>
# Dratio Python client
[](https://pypi.org/project/dratio/)
[](https://dratio.readthedocs.io/en/latest/?badge=latest)
[](https://pypi.org/project/dratio/)
[](https://github.com/dratio-io/dratio-python/blob/main/LICENSE)
The Dratio Python client allows you to effortlessly access and download data from the Dratio API using Python. Integrate a wide range of datasets from Dratio into your data science projects related to marketing, consumption, demographics, or income, and make data-driven decisions to drive innovation within your organization.
Get started by installing the client and authenticating with your Dratio API key. The client provides methods to access and download the data you need, returning the data as a Pandas DataFrame for easy manipulation and analysis.
## Installation
The stable version of the Dratio Python client is available on [PyPI](https://pypi.org/project/dratio/) for Python 3.7 to 3.11, regardless of the platform. Install it using pip:
```bash
pip install dratio
```
For datasets with geographic information, ensure [geopandas](https://geopandas.org/en/stable/) is installed in your Python environment. Alternatively, install the package with all necessary dependencies using pip:
```bash
pip install dratio[geo]
```
## API Keys
To use the API, [create an API key](https://dratio.io/app/api/). If you haven't registered, [create an account on dratio.io](https://dratio.io/getstarted/).
| Remember to securely store your API keys and avoid sharing them publicly. API keys grant access to all services on your behalf. If a key is compromised, delete and create new keys.
## Getting Started
The `Client` class enables access to all API resources using your API key.
```python
from dratio import Client
client = Client('Your API key')
```
Basic functionality allows you to search and filter available datasets for download.
```python
client.list_datasets()
```
After selecting a `Dataset`, access its information and download its content as a Pandas `DataFrame` or, for datasets with geographic information, as a `GeoDataFrame`.
```python
dataset = client.get_dataset('municipalities')
df = dataset.to_pandas() # Download as DataFrame
gdf = dataset.to_geopandas() # GeoDataFrame with geographic information
```
To gain a comprehensive understanding of the Dratio Python client and explore all its features, visit the [official documentation](https://dratio.readthedocs.com) on Read the Docs.
## License & Terms and Conditions
This source code is licensed under the Apache License, Version 2.0. Obtain a copy of the License at [apache.org](https://www.apache.org/licenses/LICENSE-2.0).
The use of the data offered by this client must comply with Dratio's terms and conditions. Obtain a copy of the terms at [dratio.io/legal/](https://dratio.io/legal/terms/).
## Support
If you encounter a bug or have a feature suggestion, please log an issue or contact us through our page or via email at [info@dratio.io](mailto:info@dratio.io)
Raw data
{
"_id": null,
"home_page": "",
"name": "dratio",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "\"dratio.io\" <info@dratio.io>",
"keywords": "dratio,API,client,data,web services,pandas,geopandas,data analysis,geospatial,demographics,marketing,income,consumption,GIS",
"author": "",
"author_email": "\"dratio.io\" <info@dratio.io>",
"download_url": "https://files.pythonhosted.org/packages/11/ac/74d9c6d625ab917ba2b09f10c47c1c21ee484de12217cb005677a6eb2695/dratio-0.0.15.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://dratio.io\">\n <img src=\"https://user-images.githubusercontent.com/16774925/184549419-b05ebfd2-436e-41e2-9172-a05d53e67c1d.svg\">\n </a>\n</p>\n\n# Dratio Python client\n\n[](https://pypi.org/project/dratio/)\n[](https://dratio.readthedocs.io/en/latest/?badge=latest)\n[](https://pypi.org/project/dratio/)\n[](https://github.com/dratio-io/dratio-python/blob/main/LICENSE)\n\nThe Dratio Python client allows you to effortlessly access and download data from the Dratio API using Python. Integrate a wide range of datasets from Dratio into your data science projects related to marketing, consumption, demographics, or income, and make data-driven decisions to drive innovation within your organization.\n\nGet started by installing the client and authenticating with your Dratio API key. The client provides methods to access and download the data you need, returning the data as a Pandas DataFrame for easy manipulation and analysis.\n\n## Installation\n\nThe stable version of the Dratio Python client is available on [PyPI](https://pypi.org/project/dratio/) for Python 3.7 to 3.11, regardless of the platform. Install it using pip:\n\n```bash\npip install dratio\n```\n\nFor datasets with geographic information, ensure [geopandas](https://geopandas.org/en/stable/) is installed in your Python environment. Alternatively, install the package with all necessary dependencies using pip:\n\n```bash\npip install dratio[geo]\n```\n\n## API Keys\n\nTo use the API, [create an API key](https://dratio.io/app/api/). If you haven't registered, [create an account on dratio.io](https://dratio.io/getstarted/).\n\n| Remember to securely store your API keys and avoid sharing them publicly. API keys grant access to all services on your behalf. If a key is compromised, delete and create new keys.\n\n## Getting Started\n\nThe `Client` class enables access to all API resources using your API key.\n\n```python\nfrom dratio import Client\n\nclient = Client('Your API key')\n```\n\nBasic functionality allows you to search and filter available datasets for download.\n\n```python\nclient.list_datasets()\n```\n\nAfter selecting a `Dataset`, access its information and download its content as a Pandas `DataFrame` or, for datasets with geographic information, as a `GeoDataFrame`.\n\n```python\ndataset = client.get_dataset('municipalities')\n\ndf = dataset.to_pandas() # Download as DataFrame\ngdf = dataset.to_geopandas() # GeoDataFrame with geographic information\n```\n\nTo gain a comprehensive understanding of the Dratio Python client and explore all its features, visit the [official documentation](https://dratio.readthedocs.com) on Read the Docs.\n\n## License & Terms and Conditions\n\nThis source code is licensed under the Apache License, Version 2.0. Obtain a copy of the License at [apache.org](https://www.apache.org/licenses/LICENSE-2.0).\n\nThe use of the data offered by this client must comply with Dratio's terms and conditions. Obtain a copy of the terms at [dratio.io/legal/](https://dratio.io/legal/terms/).\n\n## Support\n\nIf you encounter a bug or have a feature suggestion, please log an issue or contact us through our page or via email at [info@dratio.io](mailto:info@dratio.io)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python client library for dratio.io API Web services",
"version": "0.0.15",
"project_urls": {
"documentation": "https://dratio.readthedocs.io/",
"homepage": "https://dratio.io",
"repository": "https://github.com/dratio-io/dratio-python"
},
"split_keywords": [
"dratio",
"api",
"client",
"data",
"web services",
"pandas",
"geopandas",
"data analysis",
"geospatial",
"demographics",
"marketing",
"income",
"consumption",
"gis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94f0ff8277e1351374c1b674df07a0d2f517778decf6258000701afdfa15764d",
"md5": "7f94206f63e8a70b2f6edf25bf57dfde",
"sha256": "db1f17b8a749f5c3ccd8b88dc25872c7e6e0081651e851b15fe84cec5b76cb96"
},
"downloads": -1,
"filename": "dratio-0.0.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f94206f63e8a70b2f6edf25bf57dfde",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 45841,
"upload_time": "2023-12-14T12:03:27",
"upload_time_iso_8601": "2023-12-14T12:03:27.610087Z",
"url": "https://files.pythonhosted.org/packages/94/f0/ff8277e1351374c1b674df07a0d2f517778decf6258000701afdfa15764d/dratio-0.0.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "11ac74d9c6d625ab917ba2b09f10c47c1c21ee484de12217cb005677a6eb2695",
"md5": "41c913b724594e06aa1e5c1f1fc07f08",
"sha256": "4cbf6f326111fde0c09206aaf328f31f17aac94b560350d0005ec4d32b355a73"
},
"downloads": -1,
"filename": "dratio-0.0.15.tar.gz",
"has_sig": false,
"md5_digest": "41c913b724594e06aa1e5c1f1fc07f08",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 32473,
"upload_time": "2023-12-14T12:03:29",
"upload_time_iso_8601": "2023-12-14T12:03:29.406776Z",
"url": "https://files.pythonhosted.org/packages/11/ac/74d9c6d625ab917ba2b09f10c47c1c21ee484de12217cb005677a6eb2695/dratio-0.0.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-14 12:03:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dratio-io",
"github_project": "dratio-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "dratio"
}
JSON
