pvoutput

PVOutput.org python API module. Works with the R2 API version spec here.

Get your API key from the account page on PVOutput

Example usage

Here's a quick code example:

    from pvoutput import PVOutput
    import json
    apikey = 'aaaaaabbbbbbccccccddddddeeeeeeffffffgggg'
    systemid = 12345
    pvo = PVOutput(apikey=apikey, systemid=systemid)
    print(json.dumps(pvo.check_rate_limit(), indent=2))

Will give you output like this:

    {
        "X-Rate-Limit-Remaining": "271",
        "X-Rate-Limit-Limit": "300",
        "X-Rate-Limit-Reset": "1570597200"
    }

There are more example code snippets in the examples directory.

Installing

Prod-ish usage

pip install pvoutput to install from pypi

Dev Install Things

python -m virtualenv .venv
source .venv/bin/activate
pip install uv
uv venv

Input validation

This is handled by the pvoutput.base.PVOutputBase.validate_data function.

It expects the input data and a dict of configuration parameters, which are described in the table below:

An example configuration

"date_val": {
    "required": True,
    "description": "Date",
    "type": date,
    "donation_required": False,
    "additional_validators" : [
        validate_delete_status_date
    ]
}

Contributing / Testing

ruff, and mypy should all pass before submitting a PR.

License

MIT License (see LICENSE), don't use this for anything you care about - I don't provide a warranty at all, and it'll likely steal your socks and underfeed your dog.

Changelog

• 0.0.1 Initial version
• 0.0.2 2019-10-12 Fixed some bugs
• 0.0.3 2019-10-13 Added PVOutput.getstatus() which returns the current status as a dict
• 0.0.4 2019-11-05 Code cleanup using sonarqube, added an error check for registernotification
• 0.0.5 Asyncio things
• 0.0.6 I broke the build when uploading to pypi, fixed in 0.0.7.
• 0.0.7 2021-12-27 #117 fix for getstatus issues
• 0.0.8 2022-01-02 @cheops did great work cleaning up a lot of my mess, and testing is much better.
• 0.0.10 2022-08-27 Added explicit timeouts to HTTP connections in the synchronous client.
• 0.0.11 2022-08-27 Added explicit timeouts to HTTP connections in the aiohttp client.
• 0.0.12 (pending) 2023-10-10 Adding addbatchstatus