A Python library that provides wrapper functions for interacting with the demeter database at a higher level.

1. Set up SSH
2. Install pyenv and poetry.
3. Install package

git clone git@github.com:SenteraLLC/demeter-utils.git
cd demeter-utils
pyenv install $(cat .python-version)
poetry config virtualenvs.in-project true
poetry env use $(cat .python-version)
poetry install

CAUTION: On WSL, some dependencies (e.g., psycopg2) return a ChefBuildError and fail to install. Installing libpq-dev and python3-dev should solve this.

sudo apt install libpq-dev python3-dev

4. Set up pre-commit to ensure all commits to adhere to black and PEP8 style conventions.

poetry run pre-commit install

• A GitHub release is created on every push to the main branch using the create_github_release.yml Github Action Workflow
• Releases can be created manually through the GitHub Actions UI as well.
• The name of the Release/Tag will match the value of the version field specified in pyproject.toml
• Release Notes will be generated automatically and linked to the Release/Tag

If using demeter-utils as a dependency in your script, simply add it to the pyproject.toml in your project repo. Be sure to uuse the ssh: prefix so Travis has access to the repo for the library build process.

[tool.poetry.dependencies]
pixels_utils = { git = "ssh://git@github.com/SenteraLLC/demeter-utils.git", branch = "main"}

Install demeter-utils and all its dependencies via poetry install.

poetry install

TBD