| Name | nigeria-geodata JSON |
| Version |
0.0.0
JSON |
| download |
| home_page | None |
| Summary | Fast and efficient access to geospatial data for Nigeria. Ideal for developers and analysts working with Nigerian geospatial information. |
| upload_time | 2024-08-24 07:57:38 |
| maintainer | None |
| docs_url | None |
| author | Emmanuel Jolaiya |
| requires_python | <4.0.0,>=3.8.1 |
| license | LICENSE |
| keywords |
nigeria
geodata
grid3
geospatial
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Nigeria Geodata
<div style="text-align: center;">
<img src="./assets/temp_logo.png" alt="Temporary logo" />
<p><em>A Python library for fast and efficient access to geospatial data for Nigeria.</em></p>
</div>
[![PyPI][pypi_badge]][pypi_link]
[![open_in_colab][colab_badge]][colab_notebook_link]
[![python_versions][supported_python_versions_badge]][pypi_link]
[pypi_badge]: https://img.shields.io/pypi/v/nigeria_geodata?color=%2334D058&label=pypi%20package
[pypi_link]: https://pypi.org/project/nigeria_geodata/
[colab_badge]: https://colab.research.google.com/assets/colab-badge.svg
[colab_notebook_link]: https://colab.research.google.com/github/jeafreezy/nigeria_geodata/blob/main
[supported_python_versions_badge]: https://img.shields.io/pypi/pyversions/fastapi.svg?color=%2334D058
---
**Documentation**: <a href="https://jeafreezy.github.io/nigeria_geodata" target="_blank">https://jeafreezy.github.io/nigeria_geodata/</a>
**Source Code**: <a href="https://github.com/jeafreezy/nigeria_geodata" target="_blank">https://github.com/jeafreezy/nigeria_geodata</a>
---
Nigeria Geodata is a fast and efficient Python client for accessing geospatial data for Nigeria.
The key features are:
- **High Performance**: Offers exceptional speed with both synchronous and asynchronous support to cater to different use cases and performance needs
- **Map Visualization**: Provides smooth map visualization using the fast [lonboard](https://developmentseed.org/lonboard/latest/) library.
- **Lightweight**: Minimal dependencies—just one required ([httpx](https://www.python-httpx.org/)), with optional extras available for additional features.
- **User-Friendly**: Easy to use and learn; set up quickly with just a few lines of code.
- **CLI Support**: Intuitive command-line interface built with Typer.
- **Real-Time Data**: Fetches up-to-date data directly from the [GRID3](https://grid3.org/) database (more to come!), ensuring you always work with the latest information.
- **Advanced Filtering**: Allows for precise filtering based on state names (e.g FCT, Lagos), bounding boxes (bbox), and areas of interest (AOI).
## Dependency
nigeria_geodata depends on only one core package:
- [Httpx](https://www.python-httpx.org/) - for the api requests.
## Additional Optional Dependencies
There are some additional dependencies you might want to install.
- [Typer](https://typer.tiangolo.com/) - for cli support.
- [Lonboard](https://developmentseed.org/lonboard/latest/) - for map visualization.
- [Geopandas](https://geopandas.org/en/stable/) - to return the data as a geodataframe.
- [Pandas](https://pandas.pydata.org/) - to return the data as a dataframe.
## Installation
Create and activate a virtual environment and then install nigeria_geodata:
To install the lightweight version using pip:
<!-- termynal -->
```py
pip install nigeria-geodata
---> 100%
```
This version will return all the data as Python objects, mostly as a list, and list of dicts.
To install it with `typer`, `lonboard` and `geopandas`:
<!-- termynal -->
```py
pip install nigeria-geodata['standard']
---> 100%
```
This version will allow you to get the data as a dataframe, geodataframe, or an interactive map.
<!-- termynal -->
```py
pip install nigeria-geodata['cli']
---> 100%
```
This version provides CLI support for the package. It is also lightweight -- It will return the data as pure Python objects.
## Get Started
For the simplest usecase, search for all the available health care data in Nigeria.
<!-- termynal -->
```py
from nigeria_geodata import Grid3, AsyncGrid3
# Sync
search_results = Grid3().search("health")
print(search_results)
# this will return a dataframe with all the available health care datasets.
# Async
search_results = await AsyncGrid3().search("health")
print(search_results)
# this will return a dataframe with all the available health care datasets.
```
Under the hood, this makes an api request to the GRID3 database to get the datasets. Refer to the **documentation** and **examples** for more use cases.
## Acknowledgment
In addition to the great libraries we're resting upon, we would also like to thank [GRID3](https://grid3.org/) for providing real-time and comprehensive geospatial data that powers this library.
## License
This project is licensed under the terms of the MIT license. See [LICENSE.MD](https://github.com/jeafreezy/nigeria_geodata?tab=License-1-ov-file).
Raw data
{
"_id": null,
"home_page": null,
"name": "nigeria-geodata",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.8.1",
"maintainer_email": null,
"keywords": "Nigeria, geodata, GRID3, geospatial",
"author": "Emmanuel Jolaiya",
"author_email": "jolaiyaemmanuel@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/28/ca/01be2c14d1bd1f5e5827a3fe2af8088eaea1a7990fcbdf98711121abbbad/nigeria_geodata-0.0.0.tar.gz",
"platform": null,
"description": "# Nigeria Geodata\n\n<div style=\"text-align: center;\">\n <img src=\"./assets/temp_logo.png\" alt=\"Temporary logo\" />\n <p><em>A Python library for fast and efficient access to geospatial data for Nigeria.</em></p>\n</div>\n\n[![PyPI][pypi_badge]][pypi_link]\n[![open_in_colab][colab_badge]][colab_notebook_link]\n[![python_versions][supported_python_versions_badge]][pypi_link]\n\n[pypi_badge]: https://img.shields.io/pypi/v/nigeria_geodata?color=%2334D058&label=pypi%20package\n[pypi_link]: https://pypi.org/project/nigeria_geodata/\n[colab_badge]: https://colab.research.google.com/assets/colab-badge.svg\n[colab_notebook_link]: https://colab.research.google.com/github/jeafreezy/nigeria_geodata/blob/main\n[supported_python_versions_badge]: https://img.shields.io/pypi/pyversions/fastapi.svg?color=%2334D058\n\n---\n\n**Documentation**: <a href=\"https://jeafreezy.github.io/nigeria_geodata\" target=\"_blank\">https://jeafreezy.github.io/nigeria_geodata/</a>\n\n**Source Code**: <a href=\"https://github.com/jeafreezy/nigeria_geodata\" target=\"_blank\">https://github.com/jeafreezy/nigeria_geodata</a>\n\n---\n\nNigeria Geodata is a fast and efficient Python client for accessing geospatial data for Nigeria.\n\nThe key features are:\n\n- **High Performance**: Offers exceptional speed with both synchronous and asynchronous support to cater to different use cases and performance needs\n- **Map Visualization**: Provides smooth map visualization using the fast [lonboard](https://developmentseed.org/lonboard/latest/) library.\n- **Lightweight**: Minimal dependencies\u2014just one required ([httpx](https://www.python-httpx.org/)), with optional extras available for additional features.\n- **User-Friendly**: Easy to use and learn; set up quickly with just a few lines of code.\n- **CLI Support**: Intuitive command-line interface built with Typer.\n- **Real-Time Data**: Fetches up-to-date data directly from the [GRID3](https://grid3.org/) database (more to come!), ensuring you always work with the latest information.\n- **Advanced Filtering**: Allows for precise filtering based on state names (e.g FCT, Lagos), bounding boxes (bbox), and areas of interest (AOI).\n\n## Dependency\n\nnigeria_geodata depends on only one core package:\n\n- [Httpx](https://www.python-httpx.org/) - for the api requests.\n\n## Additional Optional Dependencies\n\nThere are some additional dependencies you might want to install.\n\n- [Typer](https://typer.tiangolo.com/) - for cli support.\n- [Lonboard](https://developmentseed.org/lonboard/latest/) - for map visualization.\n- [Geopandas](https://geopandas.org/en/stable/) - to return the data as a geodataframe.\n- [Pandas](https://pandas.pydata.org/) - to return the data as a dataframe.\n\n## Installation\n\nCreate and activate a virtual environment and then install nigeria_geodata:\n\nTo install the lightweight version using pip:\n\n<!-- termynal -->\n\n```py\npip install nigeria-geodata\n---> 100%\n```\n\nThis version will return all the data as Python objects, mostly as a list, and list of dicts.\n\nTo install it with `typer`, `lonboard` and `geopandas`:\n\n<!-- termynal -->\n\n```py\npip install nigeria-geodata['standard']\n---> 100%\n```\n\nThis version will allow you to get the data as a dataframe, geodataframe, or an interactive map.\n\n<!-- termynal -->\n\n```py\npip install nigeria-geodata['cli']\n---> 100%\n```\n\nThis version provides CLI support for the package. It is also lightweight -- It will return the data as pure Python objects.\n\n## Get Started\n\nFor the simplest usecase, search for all the available health care data in Nigeria.\n\n<!-- termynal -->\n\n```py\nfrom nigeria_geodata import Grid3, AsyncGrid3\n# Sync\nsearch_results = Grid3().search(\"health\")\nprint(search_results)\n# this will return a dataframe with all the available health care datasets.\n\n# Async\nsearch_results = await AsyncGrid3().search(\"health\")\nprint(search_results)\n# this will return a dataframe with all the available health care datasets.\n```\n\nUnder the hood, this makes an api request to the GRID3 database to get the datasets. Refer to the **documentation** and **examples** for more use cases.\n\n## Acknowledgment\n\nIn addition to the great libraries we're resting upon, we would also like to thank [GRID3](https://grid3.org/) for providing real-time and comprehensive geospatial data that powers this library.\n\n## License\n\nThis project is licensed under the terms of the MIT license. See [LICENSE.MD](https://github.com/jeafreezy/nigeria_geodata?tab=License-1-ov-file).\n\n",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "Fast and efficient access to geospatial data for Nigeria. Ideal for developers and analysts working with Nigerian geospatial information.",
"version": "0.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/jeafreezy/nigeria_geodata/issues",
"Documentation": "https://jeafreezy.github.io/nigeria_geodata/latest/",
"Homepage": "https://jeafreezy.github.io/nigeria_geodata/latest/",
"Repository": "https://github.com/jeafreezy/nigeria_geodata"
},
"split_keywords": [
"nigeria",
" geodata",
" grid3",
" geospatial"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "92b3b26eb2acd1e2c1273168b0efbe0eba32c578fda018fa5b2aeecc91a2ada5",
"md5": "2357b57b971ee1db4fa3d5bdd8bbfc33",
"sha256": "d7b65434b3488d42bdcd3a78a9cbf58f7bb4b5a4c48957751d7aa6a2b8745bb0"
},
"downloads": -1,
"filename": "nigeria_geodata-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2357b57b971ee1db4fa3d5bdd8bbfc33",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.8.1",
"size": 31653,
"upload_time": "2024-08-24T07:57:36",
"upload_time_iso_8601": "2024-08-24T07:57:36.928141Z",
"url": "https://files.pythonhosted.org/packages/92/b3/b26eb2acd1e2c1273168b0efbe0eba32c578fda018fa5b2aeecc91a2ada5/nigeria_geodata-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "28ca01be2c14d1bd1f5e5827a3fe2af8088eaea1a7990fcbdf98711121abbbad",
"md5": "346a8ebc4c64634766f5248291609a8e",
"sha256": "d063b09a801445b89638c483d9ad76ef0e405e5d61dad625fa0d2a8454c53d26"
},
"downloads": -1,
"filename": "nigeria_geodata-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "346a8ebc4c64634766f5248291609a8e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.8.1",
"size": 25539,
"upload_time": "2024-08-24T07:57:38",
"upload_time_iso_8601": "2024-08-24T07:57:38.711716Z",
"url": "https://files.pythonhosted.org/packages/28/ca/01be2c14d1bd1f5e5827a3fe2af8088eaea1a7990fcbdf98711121abbbad/nigeria_geodata-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-24 07:57:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jeafreezy",
"github_project": "nigeria_geodata",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nigeria-geodata"
}
