Analyse and manipulate timeseries related to power and gas offtake portfolios
Project description
Portfolyo is a Python package to analyse and manipulate timeseries related to power and gas offtake portfolios.
Installation
pip install portfolyo
NB: 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 install
Feature 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 number
Then, 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.
Project details
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.
Source Distribution
Built Distribution
Hashes for portfolyo-0.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 055fef7a2772adf1598d4662a62f484cd920c2acfba041bfcef53a44e6154115 |
|
MD5 | ac34b18d00ac89da39d6ae856e2e282a |
|
BLAKE2b-256 | 6ae6dd957db2adf149571ae6384404c2a58de66c11d87d68f79d23433aab03df |