SDK for interacting with the PVSite database
Project description
pvsite_datamodel
Python library to interact with PV Site postgres database
Install the dependencies (requires poetry)
poetry install
Structure
pvsite_datamodel:
read: # Sub package containing modules for reading from the database
write: # Sub package containing modules for writing to the database
- connection.py # Class for connecting to the database
- schema.py # Pandera pandas dataframe validation schemas
- sqlmodels.py # SQLAlchemy definitions of table schemas
tests: # External tests package
Top-level functions
Classes specifying table schemas:
- SiteSQL
- GenerationSQL
- ForecastSQL
- ForecastValueSQL
- ClientSQL
- StatusSQL
Database connection objects:
- DatabaseConnection
Read package functions
Currently available functions accessible via from pvsite_datamodel.read import <func>
:
- get_pv_generation_by_client
- get_pv_generation_by_sites
- get_site_by_uuid
- get_site_by_client_site_id
- get_site_by_client_site_name
- get_all_sites
- get_latest_status
- get_latest_forecast_values_by_site
Write package functions
Currently available write functions accessible via from pvsite_datamodels.write import <func>
:
- insert_generation_values
Coding style
Format the code in place.
make format
Lint the code
make lint
Running the tests
make test
Database migrations using alembic
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
Close
Hashes for pvsite_datamodel-0.1.32-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d10e0151f5f00cb0cc5e9ef1069a61ef7be6922a2513e84c9cc8922ece43e7c |
|
MD5 | 73007b3d09695a00597ac52d2bdd97f3 |
|
BLAKE2b-256 | 50c5f04ecb88c7f5b35a37fbc67748db4798800a20e71817489fa384df412d94 |