Skip to main content

Analyse and manipulate timeseries related to power and gas offtake portfolios

Project description

Pypi Github - CI (on pullrequest) Github - CI (on push) Github - Pre-commit Codecov Documentation Status

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:

https://portfolyo.readthedocs.io/

Repository

The git repository is hosted on github:

http://www.github.com/rwijtvliet/portfolyo

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

portfolyo-0.6.2.tar.gz (94.5 kB view details)

Uploaded Source

Built Distribution

portfolyo-0.6.2-py3-none-any.whl (122.5 kB view details)

Uploaded Python 3

File details

Details for the file portfolyo-0.6.2.tar.gz.

File metadata

  • Download URL: portfolyo-0.6.2.tar.gz
  • Upload date:
  • Size: 94.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for portfolyo-0.6.2.tar.gz
Algorithm Hash digest
SHA256 39e5c2ed9257b77a86dfc8236600b0f4323689a944844e7b6d0bcd517403f70e
MD5 2475f34f1071086a2db5e3c4ef6f9c97
BLAKE2b-256 be66b81c21d44d92b0700dd6df41179e3f61be4e8b38a8f9ae8d2dbea47415cd

See more details on using hashes here.

File details

Details for the file portfolyo-0.6.2-py3-none-any.whl.

File metadata

  • Download URL: portfolyo-0.6.2-py3-none-any.whl
  • Upload date:
  • Size: 122.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for portfolyo-0.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b4e1782d1869a3380e909b837a0e52358781e0104a9131d1acf18fa4199cdbdc
MD5 6b1dd0e512290eb9102a9cd6354e9d58
BLAKE2b-256 530f06f2f64e0327c4bdd0668dde0a3760c2f5466ab0dba9df663bd22dfd3812

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page