Opvia Scripts

This repo is used to build custom cards on the Opvia platform.

Developing

This project requires Poetry version 1.2.2 or newer and Python 3.9.x.

Install Poetry and pyenv:

curl -sSL https://install.python-poetry.org | python3 -
brew install pyenv

and then follow instructions from pyenv init to setup your shell. Once that's done, install the correct version of python and set up poetry:

pyenv install 3.9 && pyenv local 3.9 && poetry env use python3.9

You can then use poetry as usual to install your dependencies:

poetry install

If you are using VSCode, it will notice that poetry has created a new virtualenv and prompt you to use it. If it doesn't, you can cmd+shift+p -> Python: Select Interpreter -> Python 3.9.15 ('.venv': poetry) ./venv/bin/python at any point. If you then open up a new shell, vscode will automatically activate this venv for you.

PRs made to this repo require approval from another developer. There should be reasonable tests for all functionality. Tests should protect backwards-compatibility of all of our changes.

New changes should be accompanied by appropriate updates to the docs, covering:

• Relevant class and function definitions for custom card writers
• Simple examples covering installed script functionality
• Independently readable in-app scripting versions of the same examples

Useful Commands

Note: if you are not inside the virtual environment created by poetry, you may need to use poetry run poe instead of poe

• poe autoformat - Autoformat code
• poe lint - Linting
• poe test - Run Tests
• poe docs - Build docs

Release

Release a new version by manually running the release action on GitHub with a 'major', 'minor', or 'patch' version bump selected. This will create an push a new semver tag of the format v1.2.3.

Pushing this tag will trigger an action to release a new version of your library to PyPI.

Optionally create a release from this new tag to let users know what changed.