commit f1c539519e5e9158cf20ebddf9f8c695e8784260 Author: Valentin Haudiquet Date: Fri Feb 6 23:52:26 2026 +0100 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a89928f --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +venv/ +build/ +*.charm +.tox/ +.coverage +__pycache__/ +*.py[cod] +.idea +.vscode/ +src/static/ \ No newline at end of file diff --git a/.launchpad.yaml b/.launchpad.yaml new file mode 100644 index 0000000..a715f5e --- /dev/null +++ b/.launchpad.yaml @@ -0,0 +1,13 @@ +pipeline: + - tox + +jobs: + tox: + series: noble + architectures: amd64 + snaps: + - astral-uv + run: | + uv tool install tox --with tox-uv + export PATH="${HOME}/.local/bin:${PATH}" + tox diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b8064bd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Contributing + +To make contributions to this charm, you'll need a working +[development setup](https://documentation.ubuntu.com/juju/3.6/howto/manage-your-deployment/#set-up-your-deployment-local-testing-and-development). + +You can create an environment for development with `tox`: + +```shell +tox devenv -e integration +source venv/bin/activate +``` + +## Testing + +This project uses `tox` for managing test environments. There are some pre-configured environments +that can be used for linting and formatting code when you're preparing contributions to the charm: + +```shell +tox run -e format # update your code according to linting rules +tox run -e lint # code style +tox run -e static # static type checking +tox run -e unit # unit tests +tox run -e integration # integration tests +tox # runs 'format', 'lint', 'static', and 'unit' environments +``` + +## Build the charm + +Build the charm in this git repository using: + +```shell +charmcraft pack +``` + +