Skip to content

alphagov/licensing-common

Repository files navigation

Licensing Common

Licensing allows citizens and businesses to apply for licences (and similar) from local and competent authorities.

There is a legal requirement that authorities offer an online mechanism to apply for certain licences and permissions.

Licensing exists for authorities which can't or don't want to offer their own licensing application.

Licensing Common holds models, and logic shared across different components of the Licensing applications.

Setup

Mise

This project uses mise-en-place to provide specific versions of tools, listed in .tool-versions. You should set up mise to activate automatically

UV

This project uses UV to manage packages and dependencies.

To install UV if not already present, run the following command:

MacOS

brew install uv

Use uv sync to create a virtual environment with all necessary dependencies and packages already resolved.

Activate the virtual environment by running source .venv/bin/activate from the root of the project if uv hasn't already done this for you

Direnv

Get direnv to load required environment variables automatically by setting up the direnv hook to run when your shell starts up.

You will also need to allow direnv to load environment variables from this directory with direnv allow .

Pre-commit

This project also uses pre-commit run pre-commit install to create the correct pre-commit git hooks.

Testing

Ensure local database instance is running with port 27017 exposed.

With an activated virtual environment run make test to run pytest test suite. This will create a local instance of DocumentDB, run the tests, and tear down the instance of DocumentDB

Licence

MIT License

About

Allows citizens and businesses to apply for licences from local and competent authorities

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages