Skip to main content

Easy access to world's protected areas

Project description

Logo pywdpa

pywdpa Python package

Python version PyPI version GitHub Actions License GPLv3 Zenodo

Overview

The pywdpa Python package is an interface to the World Database on Protected Areas (WDPA) hosted on the Protected Planet website at https://www.protectedplanet.net. The pywdpa package provides functions to download shapefiles of protected areas (PA) for any countries with an iso3 code using the Protected Planet API at https://api.protectedplanet.net. The pywdpa package translates some functions of the R package worldpa (https://github.com/FRBCesab/worldpa) in the Python language.

protected-planet

Terms and conditions

You must ensure that the following citation is always clearly reproduced in any publication or analysis involving the Protected Planet Materials in any derived form or format:

UNEP-WCMC and IUCN (YEAR) Protected Planet: The World Database on Protected Areas (WDPA). Cambridge, UK: UNEP-WCMC and IUCN. Available at: www.protectedplanet.net (dataset downloaded the YEAR/MONTH).

For further details on terms and conditions of the WDPA usage, please visit the page: https://www.protectedplanet.net/c/terms-and-conditions.

Prerequisites

This package uses the Protected Planet API to access data on world protected areas. You must first have obtained a Personal API Token by filling in the form available at https://api.protectedplanet.net/request. Then you need to set an environment variable (we recommend using the name WDPA_KEY) using either the command os.environ["WDPA_KEY"]="your_token" or python-dotenv.

Installation

The easiest way to install the pywdpa Python package is via pip:

$ # For version on PyPI
$ python -m pip install pywdpa

or

$ # For development version on GitHub
$ python -m pip install https://github.com/ghislainv/pywdpa/archive/master.zip

but you can also install pywdpa executing the setup.py file:

$ git clone https://github.com/ghislainv/pywdpa
$ cd pywdpa
$ python setup.py install

Contributing

The pywdpa Python package is Open Source and released under the GNU GPL version 3 license. Anybody who is interested can contribute to the package development following our Community guidelines. Every contributor must agree to follow the project’s Code of conduct.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pywdpa, version 0.1.5
Filename, size File type Python version Upload date Hashes
Filename, size pywdpa-0.1.5-py2.py3-none-any.whl (20.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pywdpa-0.1.5.tar.gz (20.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page