p1-data-client-python 1.1.0

Package for P1 Data API access

• Particle.One Data API
  • Description
  • Prerequisites
  • Installation
  • Getting a Particle.One token
• Quick Start
  • Data API
  • Edgar Data API
  • Run tests
  • Useful links
• License

Particle.One Data API

Description

This package contains:

• p1_data_client_python
  • A Python module wrapping the Data REST API and Edgar Data REST API into a Pandas-friendly interface
• notebooks/p1_data_client_example.ipynb
  • An example Jupyter notebook showing how to use the Python module
• notebooks/p1_edgar_data_client_example.ipynb
  • An example Jupyter notebook showing how to use the Edgar Data REST API
• notebooks/p1_data_api_v1_example.ipynb
  • An example Jupyter notebook showing how to connect to the Data REST API directly
• test/client_examples.py
  • Minimal example of API and EDGAR clients

Prerequisites

• Python version >= 3.7

Installation

• To install from PyPI:

  > pip install p1_data_client_python
  

• To install from source:

  # Check out the code.
  > git clone [e-mail]:ParticleDev/p1_data_client_python.git
  > cd p1_data_client_python
  
  # Create environment.
  > python3 -m venv ./venv
  > source venv/bin/activate
  > pip install -r requirements.txt
  
  # Test.
  # Ensure the package is visible.
  # If not you need to add to PYTHONPATH the path of this package.
  # > export PYTHONPATH=$PYTHONPATH:$(pwd)
  > python -c "import p1_data_client_python; print(p1_data_client_python)"
  <module 'p1_data_client_python' (namespace)>
  > export P1_API_TOKEN='your_token_here'
  # E.g, export P1_API_TOKEN = 'e44e7c6b04ef3ea1cfb7a8a67db74751c177259e'
  > pytest -x
  

Getting a Particle.One token

• Go to https://particle.one/ and request a free token
• The token looks like e44e7c6b04ef3ea1cfb7a8a67db74751c177259e

Quick Start

Configuring through environment variables

• To use the notebooks, unit tests, and examples you need to configure the environment with:

  > export P1_API_URL='https://data.particle.one'
  > export P1_API_TOKEN='your_api_token_here'
  > export P1_EDGAR_API_URL='https://data.dev.alpha.service.particle.one/edgar/v1'
  > export P1_EDGAR_API_TOKEN='your_edgar_token_here'
  

• E.g.,

  > export P1_API_URL="https://data.particle.one"
  > export P1_API_TOKEN='e44e7c6b04ef3ea1cfb7a8a67db74751c177259e'
  > export P1_EDGAR_API_URL="https://data.dev.alpha.service.particle.one/edgar/v1"
  > export P1_EDGAR_API_TOKEN='8c9c9458b145202c7a6b6cceaabd82023e957a46d6cf7061ed8e1c94a168f2fd'
  

Run tests

• To run all tests with bash just run:

  > export P1_API_TOKEN='your_token_here'
  # E.g, export P1_API_TOKEN = 'e44e7c6b04ef3ea1cfb7a8a67db74751c1772598'
  > 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 20 items
  
  test/test_client.py ....
  test/test_client_jupyter.py .
  test/test_client_mock.py ....
  test/test_edgar_client.py ........
  test/test_edgar_client_mock.py ...
  ================================================================================================ 9 passed in 3.46s =================================================================================================
  

Useful links

• GitHub repo
  • https://github.com/ParticleDev/p1_data_client_python
• Rest API documentation
  • https://doc.particle.one
• Data entry point
  • https://data.particle.one

License

MIT License