Metadata-Version: 2.1
Name: pygadm
Version: 0.5.2
Summary: Easy access to administrative boundary defined by GADM from Python scripts
Project-URL: Homepage, https://github.com/12rambau/pygadm
Author-email: Pierrick Rambaud <pierrick.rambaud49@gmai.com>
License: MIT
License-File: AUTHORS.rst
License-File: LICENSE
Keywords: Python
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.8
Requires-Dist: deprecated>=1.2.14
Requires-Dist: geopandas
Requires-Dist: pyarrow
Requires-Dist: requests-cache
Provides-Extra: doc
Requires-Dist: geemap; extra == 'doc'
Requires-Dist: httplib2; extra == 'doc'
Requires-Dist: ipykernel; extra == 'doc'
Requires-Dist: ipyleaflet; extra == 'doc'
Requires-Dist: jupyter-sphinx; extra == 'doc'
Requires-Dist: pydata-sphinx-theme; extra == 'doc'
Requires-Dist: sphinx-autoapi; extra == 'doc'
Requires-Dist: sphinx-copybutton; extra == 'doc'
Requires-Dist: sphinx-design; extra == 'doc'
Requires-Dist: sphinx-favicon; extra == 'doc'
Requires-Dist: sphinx<7; extra == 'doc'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-deadfixtures; extra == 'test'
Requires-Dist: pytest-regressions>=2.4.3; extra == 'test'
Requires-Dist: pytest-sugar; extra == 'test'
Description-Content-Type: text/x-rst


pyGADM
======

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg?logo=opensourceinitiative&logoColor=white
    :target: LICENSE
    :alt: License: MIT

.. image:: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?logo=git&logoColor=white
   :target: https://conventionalcommits.org
   :alt: conventional commit

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
   :alt: Black badge

.. image:: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?logo=prettier&logoColor=white
   :target: https://github.com/prettier/prettier
   :alt: prettier badge

.. image:: https://img.shields.io/badge/pre--commit-active-yellow?logo=pre-commit&logoColor=white
    :target: https://pre-commit.com/
    :alt: pre-commit

.. image:: https://img.shields.io/pypi/v/pygadm?color=blue&logo=pypi&logoColor=white
    :target: https://pypi.org/project/pygadm/
    :alt: PyPI version

.. image:: https://img.shields.io/github/actions/workflow/status/12rambau/pygadm/unit.yaml?logo=github&logoColor=white
    :target: https://github.com/12rambau/pygadm/actions/workflows/unit.yaml
    :alt: build

.. image:: https://img.shields.io/codecov/c/github/12rambau/pygadm?logo=codecov&logoColor=white
    :target: https://codecov.io/gh/12rambau/pygadm
    :alt: Test Coverage

.. image:: https://img.shields.io/readthedocs/pygadm?logo=readthedocs&logoColor=white
    :target: https://pygadm.readthedocs.io/en/latest/
    :alt: Documentation Status

Overview
--------

Easy access to administrative boundary defined by GADM from a Python scripts.

This lib provides access to GADM datasets from a Python script without downloading the file from their server. We provide access to The current version (4.1.) which delimits 400,276 administrative areas.

The data are freely available for academic use and other non-commercial use. Redistribution, or commercial use is not allowed without prior permission. See the `license <https://gadm.org/license.html>`__ of the GADM project for more details.

.. note::

   the dataset are generated in the GADM (Global Administrative Areas) project from Berkeley University. Any request relative to the geometries should be redirected to them.

install it using either ``pip`` or ``conda``:

.. code-block:: console

   pip install pygadm

and then request area of interest from their name or GADM Id:

.. code-block:: python

   import pygadm

   gdf = pygadm.AdmItems(name="Singapore", content_level=1)

Credits
-------

This package was created with `Copier <https://copier.readthedocs.io/en/latest/>`__ and the `@12rambau/pypackage <https://github.com/12rambau/pypackage>`__ 0.1.5 project template .
