| Name | portfolyo JSON |
| Version |
0.6.6
JSON |
| download |
| home_page | None |
| Summary | Analyse and manipulate timeseries related to power and gas offtake portfolios |
| upload_time | 2025-03-13 15:13:14 |
| maintainer | None |
| docs_url | None |
| author | Ruud Wijtvliet |
| requires_python | <4.0,>=3.10 |
| license | BSD-3 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
=========
portfolyo
=========
.. image:: https://img.shields.io/pypi/v/portfolyo
:target: https://pypi.org/project/portfolyo
:alt: Pypi
.. image:: https://github.com/rwijtvliet/portfolyo/actions/workflows/ci-on-pullreq.yaml/badge.svg
:target: https://github.com/rwijtvliet/portfolyo/actions/workflows/ci-on-pullreq.yaml
:alt: Github - CI (on pullrequest)
.. image:: https://github.com/rwijtvliet/portfolyo/actions/workflows/ci-on-push.yaml/badge.svg
:target: https://github.com/rwijtvliet/portfolyo/actions/workflows/ci-on-push.yaml
:alt: Github - CI (on push)
.. image:: https://github.com/rwijtvliet/portfolyo/actions/workflows/pre-commit.yaml/badge.svg
:target: https://github.com/rwijtvliet/portfolyo/actions/workflows/pre-commit.yaml
:alt: Github - Pre-commit
.. image:: https://img.shields.io/codecov/c/gh/rwijtvliet/portfolyo
:target: https://app.codecov.io/gh/rwijtvliet/portfolyo
:alt: Codecov
.. image:: https://readthedocs.org/projects/portfolyo/badge/?version=latest
:target: https://portfolyo.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
Portfolyo is a Python package to analyse and manipulate timeseries related to power
and gas offtake portfolios.
------------
Installation
------------
.. code-block:: bash
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:
.. code-block:: bash
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.
.. code-block:: bash
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:
.. code-block:: bash
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.
Raw data
{
"_id": null,
"home_page": null,
"name": "portfolyo",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Ruud Wijtvliet",
"author_email": "rwijtvliet@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/78/a0/836edcb90131d3e5831e77df36cd0da6f8d3ba27fadca8ca4bcd4bb48a07/portfolyo-0.6.6.tar.gz",
"platform": null,
"description": "=========\nportfolyo\n=========\n\n.. image:: https://img.shields.io/pypi/v/portfolyo\n :target: https://pypi.org/project/portfolyo\n :alt: Pypi\n\n.. image:: https://github.com/rwijtvliet/portfolyo/actions/workflows/ci-on-pullreq.yaml/badge.svg\n :target: https://github.com/rwijtvliet/portfolyo/actions/workflows/ci-on-pullreq.yaml\n :alt: Github - CI (on pullrequest)\n\n.. image:: https://github.com/rwijtvliet/portfolyo/actions/workflows/ci-on-push.yaml/badge.svg\n :target: https://github.com/rwijtvliet/portfolyo/actions/workflows/ci-on-push.yaml\n :alt: Github - CI (on push)\n\n.. image:: https://github.com/rwijtvliet/portfolyo/actions/workflows/pre-commit.yaml/badge.svg\n :target: https://github.com/rwijtvliet/portfolyo/actions/workflows/pre-commit.yaml\n :alt: Github - Pre-commit\n\n.. image:: https://img.shields.io/codecov/c/gh/rwijtvliet/portfolyo\n :target: https://app.codecov.io/gh/rwijtvliet/portfolyo\n :alt: Codecov\n\n.. image:: https://readthedocs.org/projects/portfolyo/badge/?version=latest\n :target: https://portfolyo.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\nPortfolyo is a Python package to analyse and manipulate timeseries related to power \nand gas offtake portfolios.\n\n\n------------\nInstallation\n------------\n\n.. code-block:: bash\n\n pip install portfolyo\n\nNB: 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:\n\n.. code-block:: bash\n\n pip install portfolyo==x.y.z\n\n # or, in pyproject.toml\n portfolyo = \"x.y.z\"\n\n\n-------------\nDocumentation\n-------------\n\nDocumentation is hosted on readthedocs:\n\nhttps://portfolyo.readthedocs.io/\n\n\n----------\nRepository\n----------\n\nThe git repository is hosted on github:\n\nhttp://www.github.com/rwijtvliet/portfolyo\n\n\n----------\nDeveloping\n----------\n\nThis project uses ``black`` to format code and ``flake8`` for linting. We also support ``pre-commit`` to ensure\nthese have been run. To configure your local environment please install these development dependencies and set up\nthe commit hooks.\n\n.. code-block:: bash\n\n poetry install --with dev,test\n pre-commit install\n\nFeature branches are merged into the ``develop`` branch via pull request.\n\n\nInternal dependencies\n---------------------\n\nInside 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:\n\ntools >> pfline >> pfstate >> tools2\n\n\n----------\nPublishing\n----------\n\nTo 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:\n\n.. code-block:: bash\n\n create_release_branch.sh major # or minor, or patch, or specific version number\n\nThen, from the github website, the release can be published by clicking the \"tags\" button. Be sure to select the correct branch.\n\nWhen done, merge the release branch into ``develop`` and ``main``, also via pull request, and delete it.\n\n",
"bugtrack_url": null,
"license": "BSD-3",
"summary": "Analyse and manipulate timeseries related to power and gas offtake portfolios",
"version": "0.6.6",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "6a38cb7b68042206709395b799efe409a65789a615af0eff4ca5c29ef0fc7e2a",
"md5": "60d7e61eba3572cc2592643f5d6e75f6",
"sha256": "1b10ad9935f8834e61db51bdf0670ee5f3fd722ac169d86b823a189fa5669db2"
},
"downloads": -1,
"filename": "portfolyo-0.6.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "60d7e61eba3572cc2592643f5d6e75f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 112666,
"upload_time": "2025-03-13T15:13:12",
"upload_time_iso_8601": "2025-03-13T15:13:12.898285Z",
"url": "https://files.pythonhosted.org/packages/6a/38/cb7b68042206709395b799efe409a65789a615af0eff4ca5c29ef0fc7e2a/portfolyo-0.6.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "78a0836edcb90131d3e5831e77df36cd0da6f8d3ba27fadca8ca4bcd4bb48a07",
"md5": "6e4f08cd8a884d1aefa27b103c256378",
"sha256": "111349e2192d2c7fc1fac6a4b1ce1a7e19fef5f2ca4f6566a23b0fef5f308e23"
},
"downloads": -1,
"filename": "portfolyo-0.6.6.tar.gz",
"has_sig": false,
"md5_digest": "6e4f08cd8a884d1aefa27b103c256378",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 82501,
"upload_time": "2025-03-13T15:13:14",
"upload_time_iso_8601": "2025-03-13T15:13:14.560770Z",
"url": "https://files.pythonhosted.org/packages/78/a0/836edcb90131d3e5831e77df36cd0da6f8d3ba27fadca8ca4bcd4bb48a07/portfolyo-0.6.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-13 15:13:14",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "portfolyo"
}
