pvsite-datamodel 0.1.29

SDK for interacting with the PVSite database

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

./alembic