Portfolyo is a Python package to analyse and manipulate timeseries related to power and gas offtake portfolios.
Installation
pip install portfolyoNB: this package is under active development and the API will change without prior notice. To ensure your code will continue to work, pin the version number that you install:
pip install portfolyo==x.y.z
# or, in pyproject.toml
portfolyo = "x.y.z"Documentation
Documentation is hosted on readthedocs:
Repository
The git repository is hosted on github:
Developing
This project uses black to format code and flake8 for linting. We also support pre-commit to ensure these have been run. To configure your local environment please install these development dependencies and set up the commit hooks.
poetry install --with dev,test
pre-commit installFeature branches are merged into the develop branch via pull request.
Internal dependencies
Inside the package, modules depend on each other in the following chain. A module may depend on another module if it is further to the left:
tools >> pfline >> pfstate >> tools2
Publishing
To publish a new release from develop, create a new branch, increment the version number and push to github. For convenience, there is a create_release_branch.sh script that accomplishes the same, which takes one argument:
create_release_branch.sh major # or minor, or patch, or specific version numberThen, from the github website, the release can be published by clicking the “tags” button. Be sure to select the correct branch.
When done, merge the release branch into develop and main, also via pull request, and delete it.
2 maintainers
Release files for portfolyo 0.6.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| portfolyo-0.6.7.tar.gz | 82.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| portfolyo-0.6.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 195.1 kB
Release files / portfolyo-0.6.7.tar.gz
| Download URL | portfolyo-0.6.7.tar.gz |
|---|---|
| Size | 82.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fa4c3ad00ded79348cc13bb10dc5790d6cb908b9ff5d10978095d46677cb9c17
|
|
BLAKE2b-256 checksum How to use checksums |
a765aa9f5d05a53b513234597bbba24eecbaa396b59d8c222bbc3c649e377591
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.21
|
Release files / portfolyo-0.6.7-py3-none-any.whl
| Download URL | portfolyo-0.6.7-py3-none-any.whl |
|---|---|
| Size | 112.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6b81f90f6ccb72e392e51883dcf92294761ca99745841b734cfd6bd141d98ee3
|
|
BLAKE2b-256 checksum How to use checksums |
ffa9f782d435a0ba746e6e3dcf58e68326da263ce588991496314ee9dbb47f87
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.21
|
