diff --git a/cookiecutter.json b/cookiecutter.json index c1420074339e4c73bc3df7833b11e08416c6c52b..35e5d91c6ad2f6d25e5c40fd3d73251ac85909c4 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -1,6 +1,6 @@ { "project_name": "My Awesome App", "project_slug": "{{ cookiecutter.project_name.lower()|replace(' ', '_')|replace('-', '_')|replace('.', '_')|trim() }}", - "project_url": "git.astron.nl/{{ cookiecutter.project_slug }}", + "project_url": "https://git.astron.nl/{{ cookiecutter.project_slug }}", "description": "An example package for CI/CD working group" } diff --git a/{{cookiecutter.project_slug}}/.gitlab-ci.yml b/{{cookiecutter.project_slug}}/.gitlab-ci.yml index 93fffaca4e6fa5cee5b6ad53e29496bcaba216b1..337675520d9e8488af18c0e56178f643b637c926 100644 --- a/{{cookiecutter.project_slug}}/.gitlab-ci.yml +++ b/{{cookiecutter.project_slug}}/.gitlab-ci.yml @@ -1,5 +1,7 @@ default: - image: $CI_REGISTRY_IMAGE/ci-build-runner:$CI_COMMIT_REF_SLUG + image: + name: $CI_REGISTRY_IMAGE/ci-build-runner:$CI_COMMIT_REF_SLUG + pull_policy: always before_script: - python --version # For debugging cache: diff --git a/{{cookiecutter.project_slug}}/README.md b/{{cookiecutter.project_slug}}/README.md index 12a816d59c4e128a37a07c3ab27c26a11d44e94c..eb72cc45252e58acb7ef6c402be0444c062aa212 100644 --- a/{{cookiecutter.project_slug}}/README.md +++ b/{{cookiecutter.project_slug}}/README.md @@ -2,9 +2,9 @@   -<!--  --> +<!--  --> -An example repository of an CI/CD pipeline for building, testing and publishing a python package. +{{cookiecutter.description}} ## Installation ``` diff --git a/{{cookiecutter.project_slug}}/docs/source/conf.py b/{{cookiecutter.project_slug}}/docs/source/conf.py index c14432747f3fbb5409e54edb47eb8f80b41dc99a..17a5fcaf653b3253e3b02c97d93d96d02c221311 100644 --- a/{{cookiecutter.project_slug}}/docs/source/conf.py +++ b/{{cookiecutter.project_slug}}/docs/source/conf.py @@ -3,7 +3,7 @@ import os -from {{cookiecutter.project_slug}} import __version__ +from {{cookiecutter.project_slug}}._version import __version__ # -- General configuration ---------------------------------------------------- diff --git a/{{cookiecutter.project_slug}}/setup.cfg b/{{cookiecutter.project_slug}}/setup.cfg index ac0ae10fd9566ad1f8cb48ca1c780dc3b5be040e..5755b7a8b2f78bfd0d3f0d2651353b67220e5913 100644 --- a/{{cookiecutter.project_slug}}/setup.cfg +++ b/{{cookiecutter.project_slug}}/setup.cfg @@ -1,9 +1,9 @@ [metadata] name = {{cookiecutter.project_slug}} -description = An example package for CI/CD working group +description = {{cookiecutter.description}} long_description = file: README.md long_description_content_type = text/markdown -url = https://git.astron.nl/templates/python-package +url = {{cookiecutter.project_url}} license = Apache License 2.0 classifiers = Development Status :: 3 - Alpha diff --git a/{{cookiecutter.project_slug}}/tox.ini b/{{cookiecutter.project_slug}}/tox.ini index 871b5debda40fc76c1dc1cf36cac110e05c926eb..5132bd5451807aea8ab5480b5c5671b5daf67c1a 100644 --- a/{{cookiecutter.project_slug}}/tox.ini +++ b/{{cookiecutter.project_slug}}/tox.ini @@ -1,7 +1,9 @@ [tox] # Generative environment list to test all supported Python versions -envlist = py3{8,9,10,11,12},black,pep8,pylint -minversion = 3.18.0 +envlist = py3{9,10,11,12,13},black,pep8,pylint +min_version = 4.3.3 +requires = + tox-ignore-env-name-mismatch >= 0.2.0 [testenv] usedevelop = True @@ -9,25 +11,24 @@ package = wheel wheel_build_env = .pkg setenv = - LANGUAGE=en_US - LC_ALL=en_US.UTF-8 PYTHONWARNINGS=default::DeprecationWarning deps = -r{toxinidir}/requirements.txt -r{toxinidir}/tests/requirements.txt commands = {envpython} --version - {envpython} -m pytest + {envpython} -m pytest tests/{posargs} [testenv:coverage] commands = {envpython} --version - {envpython} -m pytest --cov-report term --cov-report xml --cov-report html --cov={{cookiecutter.project_slug}} + {envpython} -m pytest --cov-report term --cov-report xml --cov-report html --cov={{cookiecutter.project_slug}} tests/{posargs} # Use generative name and command prefixes to reuse the same virtualenv # for all linting jobs. [testenv:{pep8,black,pylint,format}] usedevelop = False +package = editable envdir = {toxworkdir}/linting commands = pep8: {envpython} -m flake8 --version diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/__init__.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/__init__.py index 58d3379529ec297099b77b8ce5c9df5f59798ca8..d0dc7a8b9fdc782a653702d3933e42b4827a7db8 100644 --- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/__init__.py +++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/__init__.py @@ -2,10 +2,3 @@ # SPDX-License-Identifier: Apache-2.0 """ {{cookiecutter.project_name}} """ - -try: - from importlib import metadata -except ImportError: # for Python<3.8 - import importlib_metadata as metadata - -__version__ = metadata.version("{{cookiecutter.project_slug}}")