ignition-copier-templates

ignition-devs copier templates for Ignition projects.

Pre-requisites

• Git

• Python 2.7.18 (for jython-package and python2-package)

• Python 3.12 (for mypy)

• copier

    python3 -m pip install copier

Templates

ignition-project

• Automated code checks before committing to version control using pre-commit
• Pre-configured tools for code formatting, quality analysis and testing:
  • black
  • docformatter
  • flake8
  • isort
  • pydocstyle
  • pylint
  • sort-all
  • ssort
• Tests run with sourcery and tox
• Python 2.7.18
• Auto-generated CHANGELOG.md from git commits using [commitizen]

jython-package

• Automated code checks before committing to version control using pre-commit
• Pre-configured tools for code formatting, quality analysis and testing:
  • black
  • docformatter
  • flake8
  • isort
  • mypy
  • pydocstyle
  • pylint
  • sort-all
  • ssort
• Tests run with sourcery, tox and make
• Jython 2.7.3, Python 2.7.18
• Auto-generated CHANGELOG.md from git commits using [commitizen]

python2-package

• Automated code checks before committing to version control using pre-commit
• Pre-configured tools for code formatting, quality analysis and testing:
  • black
  • docformatter
  • flake8
  • isort
  • mypy
  • pydocstyle
  • pylint
  • sort-all
  • ssort
• Tests run with sourcery and tox
• Python 2.7.18
• Auto-generated CHANGELOG.md from git commits using [commitizen]

python3-stubs

• Automated code checks before committing to version control using pre-commit
• Pre-configured tools for code formatting, quality analysis and testing:
  • black
  • docformatter
  • flake8
  • isort
  • mypy
• Tests run with tox
• Python 3.12
• Auto-generated CHANGELOG.md from git commits using [commitizen]

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/ignition-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