README.md

copier-templates

ignition-devs copier templates for Ignition projects.

Pre-requisites

• Git

• Python 2.7.18 (for jython and python)

• Python 3.12 (for mypy)

• copier

    python3 -m pip install copier

Templates

ignition

Note

This template uses the Ignition Exchange Resource Style Guide as reference.

• Automated code checks before committing to version control using pre-commit
• Pre-configured tools for code formatting, quality analysis and testing:
  • coatl-dev/flake8 + pydoclint
  • isort
  • pylint
  • ruff
  • sort-all
  • ssort
  • unimport
• Tests run with sourcery
• Python 2.7.18

jython

• Automated code checks before committing to version control using pre-commit
• Pre-configured tools for code formatting, quality analysis and testing:
  • black
  • coatl-dev/flake8 + pydoclint
  • docformatter
  • flake8 (for stubs)
  • isort
  • pydocstyle
  • pylint
  • sort-all
  • ssort
  • unimport
• Tests run with sourcery, tox and make
• Jython 2.7.3, Python 2.7.18, and Python 3.12 (for stubs)

python

• Automated code checks before committing to version control using pre-commit
• Pre-configured tools for code formatting, quality analysis and testing:
  • black
  • coatl-dev/flake8 + pydoclint
  • docformatter
  • flake8 (for stubs)
  • isort
  • pydocstyle
  • pylint
  • sort-all
  • ssort
  • unimport
• Tests run with sourcery and tox
• Python 2.7.18
• Python 3.12 (for stubs)

Quick setup and usage

Generating a project

You can generate a project from a template using the copier command-line tool:

copier copy gh:ignition-devs/copier-templates /path/to/destination

Updating a project

Navigate to your project's directory, make sure git status shows it clean, and run:

copier update --defaults