phc 0.3.1

Python interface for the PHC.

phc-sdk-py

The phc-sdk-py is a developer kit for interfacing with the PHC API on Python 3.6 and above.

Table of contents

1. Project Status
2. Getting Started
   1. Dependencies
   2. Getting the Source
   3. Development
   4. Installation
   5. Usage
3. Release Process
   1. Versioning
4. Contributing
5. License
6. Authors
7. Acknowledgements

Project Status

Back to top

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 [e-mail]:lifeomic/phc-sdk-py.git

Back to top

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.

Setup

This installs some pre-commit hooks that will format and lint new changes.

make setup

Running tests

make test

Linting

make lint

Back to top

Installation

pip3 install phc

Back to top

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 import Accounts

accounts = Accounts(session)
myaccounts = accounts.get_list()

Back to top

Release Process

Releases are generally created with each merged PR. Packages for each release are published to PyPi. See CHANGELOG.md for release notes.

Versioning

This project uses Semantic Versioning.

Back to top

Contributing

We encourage public contributions! Please review CONTRIBUTING.md and CODE_OF_CONDUCT.md for details on our code of conduct and development process.

Back to top

License

This project is licensed under the MIT License - see LICENSE file for details.

Back to top

Authors

See the list of contributors who participate in this project.

Back to top

Acknowledgements

This project is built with the following:

• aiohttp - Asynchronous HTTP Client/Server for asyncio and Python.

Back to top