Skip to content

Latest commit

 

History

History
72 lines (44 loc) · 1.42 KB

README.md

File metadata and controls

72 lines (44 loc) · 1.42 KB

Pangea Client

pangea-client is a set of libraries for different languages to interface with Pangea API.

When using python the data is delivered in Arrow or JSON, developers are required to provide their own types.


Getting started

Access to the API via pangea-client requires credentials, please apply for access first.

Once credentials are issued, they will need to be set in the environment variables.

The easiest way to use these credentials is to create a .env file in the project root folder and populate it like so:

PANGEA_USERNAME=xxxxx
PANGEA_PASSWORD=xxxxx

Examples

Checkout the github repository separately for example code.


Setup

Before proceeding, poetry needs to be installed globally.

curl -sSL https://install.python-poetry.org | python3 -

⚠️ WARNING ⚠️

DO NOT install using pip, only via the above script.


After poetry is installed, cd to the directory where you cloned the repo (python sub-folder for megarepo) and run:

poetry install

Running the Examples

poetry run python3 examples/arrow-blocks.py
poetry run python3 examples/jsonstream-status.py
poetry run python3 examples/jsonstream-blocks.py

or setup a venv shell with poetry first:

poetry shell

then you can run

python3 examples/arrow-blocks.py