Skip to content

Revelio

PyPI PyPI - Python Version PyPI - License Coookiecutter - Wolt

Documentation: https://ndido98.github.io/revelio

Source Code: https://github.com/ndido98/revelio

PyPI: https://pypi.org/project/revelio/

A declarative framework for Morphing Attack Detection experiments

Installation

git clone git@github.com:ndido98/revelio
cd revelio
poetry install
poetry run revelio

Development

  • Clone this repository
  • Requirements:
  • Poetry
  • Python 3.10+
  • Create a virtual environment and install the dependencies
poetry install
  • Activate the virtual environment
poetry shell

Testing

pytest

Documentation

The documentation is automatically generated from the content of the docs directory and from the docstrings of the public signatures of the source code. The documentation is updated and published as a Github project page automatically as part each release.

Pre-commit

Pre-commit hooks run all the auto-formatters (e.g. black, isort), linters (e.g. mypy, flake8), and other quality checks to make sure the changeset is in good shape before a commit/push happens.

You can install the hooks with (runs for each commit):

pre-commit install
pre-commit install -t commit-msg

Or if you want e.g. want to run all checks manually for all files:

pre-commit run --all-files

This project was generated using the wolt-python-package-cookiecutter template.