pygadm

Easy access to administrative boundary defined by GADM from Python scripts

https://github.com/12rambau/pygadm

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.6%) to scientific vocabulary

Keywords

administration gadm geography geopandas gis mapping python remote-sensing vector
Last synced: 6 months ago · JSON representation ·

Repository

Easy access to administrative boundary defined by GADM from Python scripts

Basic Info
Statistics
  • Stars: 8
  • Watchers: 3
  • Forks: 2
  • Open Issues: 7
  • Releases: 9
Topics
administration gadm geography geopandas gis mapping python remote-sensing vector
Created about 3 years ago · Last pushed about 1 year ago
Metadata Files
Readme Contributing License Code of conduct Citation Authors

README.rst

PyGADM
======

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

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

.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
   :target: https://github.com/astral-sh/ruff
   :alt: ruff badge

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

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

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

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/pygadm?color=blue&logo=anaconda&logoColor=white
    :target: https://anaconda.org/conda-forge/pygadm
    :alt: Conda Version

.. |build| 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

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

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

|license| |commit| |ruff| |prettier| |pre-commmit| |pypi| |conda| |build| |coverage| |docs|

Overview
--------

.. image:: docs/_static/logo.svg
    :width: 20%
    :align: right

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 `__ 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.Items(name="Singapore", content_level=1)

Credits
-------

This package was created with `Copier `__ and the `@12rambau/pypackage `__ 0.1.16 project template.

Owner

  • Name: Rambaud Pierrick
  • Login: 12rambau
  • Kind: user
  • Location: Rome, Italy
  • Company: FAO @openforis

Materials engineer turned Software Engineer and Python enthusiast for Earth Observation applications

Citation (CITATION.cff)

cff-version: "1.2.0"
message: "If you use this software, please cite it as below."
authors:
  - family-names: "Rambaud"
    given-names: "Pierrick"
    orcid: "https://orcid.org/0000-0001-8764-5749"
title: "pyGADM"
version: "0.5.3"
doi: ""
date-released: "2023-12-22"
url: "https://github.com/12rambau/pygadm"

GitHub Events

Total
  • Issues event: 6
  • Delete event: 5
  • Issue comment event: 14
  • Push event: 8
  • Pull request event: 8
  • Fork event: 1
  • Create event: 4
Last Year
  • Issues event: 6
  • Delete event: 5
  • Issue comment event: 14
  • Push event: 8
  • Pull request event: 8
  • Fork event: 1
  • Create event: 4

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 142
  • Total Committers: 2
  • Avg Commits per committer: 71.0
  • Development Distribution Score (DDS): 0.113
Past Year
  • Commits: 124
  • Committers: 2
  • Avg Commits per committer: 62.0
  • Development Distribution Score (DDS): 0.129
Top Committers
Name Email Commits
12rambau p****9@g****m 126
Pierrick Rambaud p****d@l****m 16
Committer Domains (Top 20 + Academic)
ldc.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 40
  • Total pull requests: 43
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 4 days
  • Total issue authors: 10
  • Total pull request authors: 3
  • Average comments per issue: 0.55
  • Average comments per pull request: 0.77
  • Merged pull requests: 43
  • Bot issues: 3
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 7
  • Average time to close issues: about 1 hour
  • Average time to close pull requests: 17 days
  • Issue authors: 3
  • Pull request authors: 2
  • Average comments per issue: 1.33
  • Average comments per pull request: 0.86
  • Merged pull requests: 7
  • Bot issues: 1
  • Bot pull requests: 0
Top Authors
Issue Authors
  • 12rambau (28)
  • github-actions[bot] (3)
  • leoduret (2)
  • seor12 (1)
  • max-poltora (1)
  • irm-codebase (1)
  • jfmartinez4 (1)
  • srajma (1)
  • buehlpas (1)
  • kilagg (1)
Pull Request Authors
  • 12rambau (38)
  • julianwid (2)
  • leoduret (2)
Top Labels
Issue Labels
bug (5) enhancement (3)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 311 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 1
  • Total versions: 10
  • Total maintainers: 1
pypi.org: pygadm

Easy access to administrative boundary defined by GADM from Python scripts

  • Versions: 10
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 311 Last month
Rankings
Downloads: 5.8%
Dependent packages count: 10.1%
Average: 17.8%
Stargazers count: 21.5%
Dependent repos count: 21.6%
Forks count: 29.8%
Maintainers (1)
Last synced: 6 months ago

Dependencies

.github/workflows/unit.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
  • pre-commit/action v3.0.0 composite
.github/workflows/release.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
pyproject.toml pypi
  • Deprecated *
  • geopandas *
  • pyarrow *