Python interface for the PHC.
Project description
PHC SDK for Python
The phc-sdk-py is a developer kit for interfacing with the PHC API on Python 3.7 and above.
Project Status
Getting Started
Dependencies
- Python 3 version >= 3.7
Getting the Source
This project is hosted on GitHub. You can clone this project directly using this command:
git clone git@github.com:lifeomic/phc-sdk-py.git
Development
Python environments are managed using virtualenv. Be sure to have this installed first pip install virtualenv. The makefile will setup the environment for the targets listed below.
Some clients in this SDK are auto-generated. They can be re-generated at any time to pull in the latest changes by running make gen.
Setup
This installs some pre-commit hooks that will format and lint new changes.
make setup
Running tests
make test
Linting
make lint
Installation
pip install phc
Usage
A Session needs to be created first that stores the token and account information needed to access the PHC API. One can currently using API Key tokens generated from the PHC Account, or OAuth tokens generated using the CLI.
from phc import Session
session = Session(token=<TOKEN VALUE>, account="myaccount")
Once a Session is created, you can then access the different parts of the platform.
from phc.services import Accounts
accounts = Accounts(session)
myaccounts = accounts.get_list()
Release Process
Releases are generally created with each merged PR. To release a new version, update the package version in phc.version, and open a PR.
Packages for each release are published to PyPi. See CHANGELOG.md for release notes.
Versioning
This project uses Semantic Versioning.
Contributing
We encourage public contributions! Please review CONTRIBUTING.md and CODE_OF_CONDUCT.md for details on our code of conduct and development process.
License
This project is licensed under the MIT License - see LICENSE file for details.
Authors
See the list of contributors who participate in this project.
Acknowledgements
This project is built with the following:
- aiohttp - Asynchronous HTTP Client/Server for asyncio and Python.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
