Skip to content

Developer Onboarding

Clone and enter the project

git clone https://github.com/rmutegeki/allure-report-exporter.git
cd allure-report-exporter

Install dependencies

# pip
python -m pip install -e .[dev,docs]

# uv
uv sync --extra dev --extra docs

Run tests

pytest -q

Build docs locally

# pip env
mkdocs serve

# uv env
uv run mkdocs serve

Open http://127.0.0.1:8000.

Common developer tasks

  • Linting: ruff check .
  • Unit and integration tests: pytest -q
  • Local package build: python -m build
  • Package validation: python -m twine check dist/*