Skip to content

Commit

Permalink
Fix deps
Browse files Browse the repository at this point in the history
  • Loading branch information
epeters3 committed Dec 17, 2024
1 parent f93ed22 commit 0f78904
Show file tree
Hide file tree
Showing 7 changed files with 497 additions and 604 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/pr-branch-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ jobs:

strategy:
matrix:
python_version: ["3.8", "3.9", "3.10", "3.11"]
python_version: ["3.9", "3.10", "3.11", "3.12"]

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Install poetry
run: pipx install poetry==1.5.1
run: pipx install poetry==1.8.5

- name: Set up Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python_version }}
cache: "poetry"
Expand All @@ -32,5 +32,5 @@ jobs:
poetry build -f sdist
poetry build -f wheel
- if: ${{ matrix.python_version == '3.8' }}
- if: ${{ matrix.python_version == '3.9' }}
run: poetry run poe doc
10 changes: 5 additions & 5 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ jobs:
runs-on: ubuntu-latest
environment: pypi
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Install poetry
run: pipx install poetry==1.5.1
run: pipx install poetry==1.8.5

- name: Set up Python 3.8
uses: actions/setup-python@v4
- name: Set up Python 3.9
uses: actions/setup-python@v5
with:
python-version: "3.8" # pdoc works under this version
python-version: "3.9" # pdoc works under this version
cache: "poetry"

- run: poetry install
Expand Down
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ _(NOTE: All examples use fictitious data or freely available data sets.)_

## [1.0.0] - 2024-12-17

### Removed

- Support for Python 3.8 has been dropped, since 3.8 has reached end-of-life:
https://devguide.python.org/versions/

### Changed

- This project now uses `pydantic` v2 instead of v1.
Expand Down
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# PHC SDK for Python

The phc-sdk-py is a developer kit for interfacing with the [PHC API](https://api.docs.lifeomic.com/) on Python 3.7 and above.
The phc-sdk-py is a developer kit for interfacing with the
[PHC API](https://api.docs.lifeomic.com/) on Python 3.7 and above.

## Project Status

Expand All @@ -15,23 +16,27 @@ The phc-sdk-py is a developer kit for interfacing with the [PHC API](https://api

### Dependencies

- [Python 3](https://www.python.org/download/releases/3.0/) version >= 3.8
- [Python 3](https://www.python.org/download/releases/3.0/) version >= 3.9

### Getting the Source

This project is [hosted on GitHub](https://github.com/lifeomic/phc-sdk-py).

### 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](https://github.com/lifeomic/cli).
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](https://github.com/lifeomic/cli).

```python
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.
Once a `Session` is created, you can then access the different parts of the
platform.

```python
from phc.services import Accounts
Expand All @@ -42,18 +47,24 @@ myaccounts = accounts.get_list()

## Contributing

We encourage public contributions! Please review [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details on our code of conduct and development process.
We encourage public contributions! Please review
[CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](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](LICENSE) file for details.
This project is licensed under the MIT License - see [LICENSE](LICENSE) file for
details.

## Authors

See the list of [contributors](https://github.com/lifeomic/phc-sdk-py/contributors) who participate in this project.
See the list of
[contributors](https://github.com/lifeomic/phc-sdk-py/contributors) who
participate in this project.

## Acknowledgements

This project is built with the following:

- [aiohttp](https://aiohttp.readthedocs.io/en/stable/) - Asynchronous HTTP Client/Server for asyncio and Python.
- [aiohttp](https://aiohttp.readthedocs.io/en/stable/) - Asynchronous HTTP
Client/Server for asyncio and Python.
Loading

0 comments on commit 0f78904

Please sign in to comment.