Skip to main content

Installation

Two install paths: install the published package for use, or set up a Poetry workspace for local development on the framework itself.

Prerequisites​

  • Python 3.10 or higher
  • Poetry ≥ 2.0 (only for development setup) — see python-poetry.org
pip install ign-lint

Verify:

ign-lint --help

Development setup with Poetry​

Use this path if you're contributing to the framework or writing custom rules against the source.

git clone https://github.com/bw-design-group/ignition-lint.git
cd ignition-lint
poetry install

Run the CLI through Poetry:

poetry run ign-lint --help

# Or activate the virtualenv first
poetry shell
ign-lint --help

Run the test suite:

cd tests
poetry run python test_runner.py --run-all

Format and lint the framework code:

poetry run yapf -ir --style=.config/.style.yapf src/ tests/
poetry run pylint src/ tests/ scripts/ --rcfile=.config/.pylintrc

Building and distribution​

# Build the package
poetry build

# Export requirements.txt for CI/CD or Docker
poetry export --output requirements.txt --without-hashes

Next​