https://github.com/pacificclimate/pycds
An ORM representation of the PCDS and CRMP database
https://github.com/pacificclimate/pycds
actions docker pipenv pypi
Last synced: 5 months ago
JSON representation
An ORM representation of the PCDS and CRMP database
- Host: GitHub
- URL: https://github.com/pacificclimate/pycds
- Owner: pacificclimate
- License: gpl-3.0
- Created: 2014-05-08T21:23:00.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2026-01-29T21:06:39.000Z (5 months ago)
- Last Synced: 2026-01-30T08:56:18.097Z (5 months ago)
- Topics: actions, docker, pipenv, pypi
- Language: Python
- Homepage:
- Size: 3.35 MB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# PyCDS
PyCDS is a Python package that provides an [Object Relational Mapping (ORM)](http://en.wikipedia.org/wiki/Object-relational_mapping) layer for accessing meteorological observations stored in a relational database in a standard database model, referred to variously as a CRMP database or a PCDS database.
This package uses [Alembic](https://alembic.sqlalchemy.org/) to manage database creation and migration. For details, see _Database operations with Alembic_, below.
This type of database (PCDS/CRMP schema) is currently used at PCIC to store BC's long-term weather archive, the Provincial Climate Data Set (PCDS), and the Northern Climate Database (Metnorth). For details, see [Background](docs/background.md).
With this package, one can recreate the database schema in a [PostgreSQL](http://www.postgresql.org) or [SQLite](http://www.sqlite.org) database and/or use the package as an object mapper for programmatic database access. PyCDS uses [SQLAlchemy](http://www.sqlalchemy.org) to provide the ORM layer.
## Documentation
- [Background](docs/background.md)
- [Installation](docs/installation.md)
- [Scripts](docs/scripts.md)
- [ORM contents and usage](docs/orm.md)
- [History tracking](docs/history-tracking.md)
- Database operations with Alembic
- [Introduction](docs/database-operations/introduction.md)
- [Applying a migration: Upgrade](docs/database-operations/migrate-upgrade.md)
- [Applying a migration: Downgrade](docs/database-operations/migrate-downgrade.md)
- [Creating a new PyCDS database](docs/database-operations/create-new-db.md)
- Testing
- [Project unit tests](docs/testing/project-unit-tests.md)
- [Test migrations with a test database](docs/testing/test-migrations.md)
- [Unit tests in client code](docs/testing/unit-tests-in-client-code.md)
- Development
- Migrations
- [Introduction](docs/dev-notes/migrations/introduction.md)
- [IMPORTANT ADVICE AND GUIDELINES](docs/dev-notes/migrations/important-notes.md)
- [Creating a new migration](docs/dev-notes/migrations/create-new-migration.md)
- [Creating the initial migration](docs/dev-notes/migrations/create-initial-migration.md)
- [Creating and using SQLAlchemy extensions](docs/dev-notes/sqlalchemy-extensions.md)
- [Creating and using Alembic extensions](docs/dev-notes/alembic-extensions.md)
_TOC courtesy of [Lucio Paiva](https://luciopaiva.com/markdown-toc/)._
## Releasing
### Note
Below we describe incrementing the package version manually. We could consider
using the command
[`poetry version`](https://python-poetry.org/docs/cli/#version)
instead to get Poetry to do it for us.
### Production release
1. Modify `tool.poetry.version` in `pyproject.toml`: First remove any suffix
to the version number, as our convention is to reserve those for test builds
(e.g., `1.2.3` is a release build, `1.2.3.dev7` is a test build).
Then increment the release build version.
1. Summarize release changes in `NEWS.md`
1. Commit these changes, then tag the release
```bash
git add pyproject.toml NEWS.md
git commit -m"Bump to version X.Y.Z"
git tag -a -m"X.Y.Z" X.Y.Z
git push --follow-tags
```
1. Our GitHub Action `pypi-publish.yml` will build and release the package
on our PyPI server.
### Dev/test release
The process is very similar to a production release, but uses a different
version number convention, and omits any notice in NEWS.md.
1. Modify `tool.poetry.version` in `pyproject.toml`: Add or increment the suffix
in the pattern `.devN`, where N is any number of numeric digits (e.g., `1.2.3.dev11`).
Our convention is to reserve those for test releases
(e.g., `1.2.3` is a release build, `1.2.3.dev11` is a test build).
2. Commit changes and tag the release:
```bash
git add pyproject.toml
git commit -m"Create test version X.Y.Z.devN"
git tag -a -m"X.Y.Z.devN" X.Y.Z.devN
git push --follow-tags
```
1. Our GitHub Action `pypi-publish.yml` will build and release the package
on our PyPI server.