Package for P1 Data API access
Project description
Particle.One Data API
Description
This package contains:
-
A Python module
p1_data_client_python
wrapping the P1 Data REST API into a pandas-friendly interface -
An example notebook on how to use the Python module
notebook/p1_data_client_example.ipynb
-
An example Jupyter notebook on how to connect to the P1 Data REST API directly:
notebooks/p1_data_api_v1_example.ipynb
Prerequisites
- Python version >= 3.7
Installation
-
To install from PyPI:
> pip install p1_data_client_python
-
To install the packages from source:
> python3 -m venv ./venv > source venv/bin/activate > pip install -r requirements.txt # Ensure the package is visible. If not you need to add to PYTHONPATH the path # of this package. > python -c "import p1_data_client_python; print(p1_data_client_python)" <module 'p1_data_client_python' (namespace)>
Getting a Particle.One token
- Go to
https://particle.one/
and request a free token - The token looks like
e44e7c6b04ef3ea1cfb7a8a67db74751c177259e
Quick Start
import p1_data_client_python.client as p1_data
API_URL = "https://data.particle.one"
TOKEN = '<Put your token here>'
client = p1_data.Client(base_url=API_URL, token=TOKEN)
client.get_metadata_type('COMMODITIES')
client.search(text='Price', commodity=['Coal'], country=['Belize', 'Brazil'])
client.get_payload('00158d049d149197f67115a6cc3224e956e5c9e9')
Run tests
- To run all tests with
bash
just run:> export P1_API_TOKEN=<place your token here> > pytest -x =============================================================================================== test session starts ================================================================================================ platform linux -- Python 3.7.3, pytest-6.0.2, py-1.9.0, pluggy-0.13.1 rootdir: /wd/saggese/src/p1_data_client_python plugins: openfiles-0.4.0, astropy-header-0.1.2, flaky-3.7.0, doctestplus-0.4.0, remotedata-0.3.1, arraydiff-0.3, hypothesis-5.3.0 collected 9 items test/test_client.py .... [ 44%] test/test_client_jupyter.py . [ 55%] test/test_client_mock.py .... [100%] ================================================================================================ 9 passed in 3.46s =================================================================================================
``
License
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for p1_data_client_python-1.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7142681be4e01c8bad4b23288c5ff83579b24a23f2f376e4b0cfe11f2f8e7af2 |
|
MD5 | f54e44ff33fbc0136a0b564628a2fed8 |
|
BLAKE2b-256 | 40d103b9d74cc8472f7f3c018358930bb79c401feb2080c0d1b62977332a90e9 |