diff --git a/README.md b/README.md
index d52dc03b8a4e4febc26c9606d15626f28736bb83..34766ecd393f8d7576daa7e188159de3433041b5 100644
--- a/README.md
+++ b/README.md
@@ -4,40 +4,20 @@ An example repository of an CI/CD pipeline for building, testing and publishing
If you find some missing functionality with regards to CI/CD, testing, linting or something else, feel free to make a merge request with the proposed changes.
+## How to apply this template
-## Example of README.md contents below:
+This templates uses `cookiecutter` which can be
-## Installation
-```
-pip install .
+```bash
+pip install --user cookiecutter
```
-## Usage
-```
-from my_awesome_app import cool_module
+Then you can create an instance of your template with:
-cool_module.greeter() # prints "Hello World"
+```bash
+cookiecutter https://git.astron.nl/templates/python-package.git
+# Next follow a set of prompts (such as the name and description of the package)
```
-## Contributing
-
-To contribute, please create a feature branch and a "Draft" merge request.
-Upon completion, the merge request should be marked as ready and a reviewer
-should be assigned.
-
-Verify your changes locally and be sure to add tests. Verifying local
-changes is done through `tox`.
-
-```pip install tox```
-
-With tox the same jobs as run on the CI/CD pipeline can be ran. These
-include unit tests and linting.
-
-```tox```
-
-To automatically apply most suggested linting changes execute:
-
-```tox -e format```
-
## License
This project is licensed under the Apache License Version 2.0
diff --git a/cookiecutter.json b/cookiecutter.json
new file mode 100644
index 0000000000000000000000000000000000000000..b61933c29cb84cb9615e7cfcad595d2083900fb5
--- /dev/null
+++ b/cookiecutter.json
@@ -0,0 +1,5 @@
+{
+ "project_name": "My Awesome App",
+ "project_slug": "{{ cookiecutter.project_name.lower()|replace(' ', '_')|replace('-', '_')|replace('.', '_')|trim() }}",
+ "description": "An example package for CI/CD working group"
+}
diff --git a/.editorconfig b/{{cookiecutter.project_slug}}/.editorconfig
similarity index 100%
rename from .editorconfig
rename to {{cookiecutter.project_slug}}/.editorconfig
diff --git a/.gitignore b/{{cookiecutter.project_slug}}/.gitignore
similarity index 72%
rename from .gitignore
rename to {{cookiecutter.project_slug}}/.gitignore
index f886c6fad8b597bf0ab92157118d00bd31076922..3de3f10df4bb74f8d30e7ed9ebf98e44387b96f4 100644
--- a/.gitignore
+++ b/{{cookiecutter.project_slug}}/.gitignore
@@ -7,7 +7,7 @@ coverage.xml
htmlcov/*
# Setuptools SCM
-my_awesome_app/_version.py
+{{cookiecutter.project_slug}}/_version.py
# IDE configuration
.vscode
diff --git a/.gitlab-ci.yml b/{{cookiecutter.project_slug}}/.gitlab-ci.yml
similarity index 100%
rename from .gitlab-ci.yml
rename to {{cookiecutter.project_slug}}/.gitlab-ci.yml
diff --git a/{{cookiecutter.project_slug}}/LICENSE b/{{cookiecutter.project_slug}}/LICENSE
new file mode 100644
index 0000000000000000000000000000000000000000..261eeb9e9f8b2b4b0d119366dda99c6fd7d35c64
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/MANIFEST.in b/{{cookiecutter.project_slug}}/MANIFEST.in
similarity index 100%
rename from MANIFEST.in
rename to {{cookiecutter.project_slug}}/MANIFEST.in
diff --git a/{{cookiecutter.project_slug}}/README.md b/{{cookiecutter.project_slug}}/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..e0127fbcf6b4c34242ac4d4ea59c76f0cfa7ba9e
--- /dev/null
+++ b/{{cookiecutter.project_slug}}/README.md
@@ -0,0 +1,38 @@
+# {{cookiecutter.project_name}}
+
+An example repository of an CI/CD pipeline for building, testing and publishing a python package.
+
+## Installation
+```
+pip install .
+```
+
+## Usage
+```python
+from {{cookiecutter.project_slug}} import cool_module
+
+cool_module.greeter() # prints "Hello World"
+```
+
+## Contributing
+
+To contribute, please create a feature branch and a "Draft" merge request.
+Upon completion, the merge request should be marked as ready and a reviewer
+should be assigned.
+
+Verify your changes locally and be sure to add tests. Verifying local
+changes is done through `tox`.
+
+```pip install tox```
+
+With tox the same jobs as run on the CI/CD pipeline can be ran. These
+include unit tests and linting.
+
+```tox```
+
+To automatically apply most suggested linting changes execute:
+
+```tox -e format```
+
+## License
+This project is licensed under the Apache License Version 2.0
diff --git a/docs/.gitkeep b/{{cookiecutter.project_slug}}/docs/.gitkeep
similarity index 100%
rename from docs/.gitkeep
rename to {{cookiecutter.project_slug}}/docs/.gitkeep
diff --git a/pyproject.toml b/{{cookiecutter.project_slug}}/pyproject.toml
similarity index 78%
rename from pyproject.toml
rename to {{cookiecutter.project_slug}}/pyproject.toml
index 0dac729a29ca7703f10416c818c896a94f06b7e8..183007c3eb92a098dc3cc38fee60fc47e5f5884e 100644
--- a/pyproject.toml
+++ b/{{cookiecutter.project_slug}}/pyproject.toml
@@ -7,7 +7,7 @@ requires = [
build-backend = "setuptools.build_meta"
[tool.setuptools_scm]
-write_to = "my_awesome_app/_version.py"
+write_to = "{{cookiecutter.project_slug}}/_version.py"
[tool.pylint]
ignore = "_version.py"
diff --git a/requirements.txt b/{{cookiecutter.project_slug}}/requirements.txt
similarity index 100%
rename from requirements.txt
rename to {{cookiecutter.project_slug}}/requirements.txt
diff --git a/setup.cfg b/{{cookiecutter.project_slug}}/setup.cfg
similarity index 96%
rename from setup.cfg
rename to {{cookiecutter.project_slug}}/setup.cfg
index 97e129f9cc5be5f6a9b0dc946c25b493e5552d25..7213b9501bb52acfd8e123cdb65a102ae9c01bce 100644
--- a/setup.cfg
+++ b/{{cookiecutter.project_slug}}/setup.cfg
@@ -1,5 +1,5 @@
[metadata]
-name = my-awesome-app
+name = {{cookiecutter.project_slug}}
description = An example package for CI/CD working group
long_description = file: README.md
long_description_content_type = text/markdown
diff --git a/setup.py b/{{cookiecutter.project_slug}}/setup.py
similarity index 100%
rename from setup.py
rename to {{cookiecutter.project_slug}}/setup.py
diff --git a/tests/.gitkeep b/{{cookiecutter.project_slug}}/tests/.gitkeep
similarity index 100%
rename from tests/.gitkeep
rename to {{cookiecutter.project_slug}}/tests/.gitkeep
diff --git a/tests/requirements.txt b/{{cookiecutter.project_slug}}/tests/requirements.txt
similarity index 100%
rename from tests/requirements.txt
rename to {{cookiecutter.project_slug}}/tests/requirements.txt
diff --git a/tests/test_cool_module.py b/{{cookiecutter.project_slug}}/tests/test_cool_module.py
similarity index 81%
rename from tests/test_cool_module.py
rename to {{cookiecutter.project_slug}}/tests/test_cool_module.py
index 4ab4889a09bfa270c4b4a14679839277f67d6934..19e5cd2bd0bff16fa00560bdb678f9345e4e79f4 100644
--- a/tests/test_cool_module.py
+++ b/{{cookiecutter.project_slug}}/tests/test_cool_module.py
@@ -1,7 +1,7 @@
"""Testing of the Cool Module"""
from unittest import TestCase
-from my_awesome_app.cool_module import greeter
+from {{cookiecutter.project_slug}}.cool_module import greeter
class TestCoolModule(TestCase):
diff --git a/tox.ini b/{{cookiecutter.project_slug}}/tox.ini
similarity index 90%
rename from tox.ini
rename to {{cookiecutter.project_slug}}/tox.ini
index d5388949afbca56f8f7bd3c979409c7cfd78d3b0..fd945dbc95b58222e04758f382a9ee3042049064 100644
--- a/tox.ini
+++ b/{{cookiecutter.project_slug}}/tox.ini
@@ -21,7 +21,7 @@ commands =
[testenv:coverage]
commands =
{envpython} --version
- {envpython} -m pytest --cov-report xml --cov-report html --cov=map
+ {envpython} -m pytest --cov-report xml --cov-report html --cov={{cookiecutter.project_slug}}
# Use generative name and command prefixes to reuse the same virtualenv
# for all linting jobs.
@@ -34,8 +34,8 @@ commands =
black: {envpython} -m black --version
black: {envpython} -m black --check --diff .
pylint: {envpython} -m pylint --version
- pylint: {envpython} -m pylint my_awesome_app tests
- format: {envpython} -m autopep8 -v -aa --in-place --recursive my_awesome_app
+ pylint: {envpython} -m pylint {{cookiecutter.project_slug}} tests
+ format: {envpython} -m autopep8 -v -aa --in-place --recursive {{cookiecutter.project_slug}}
format: {envpython} -m autopep8 -v -aa --in-place --recursive tests
format: {envpython} -m black -v .
diff --git a/my_awesome_app/__init__.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/__init__.py
similarity index 54%
rename from my_awesome_app/__init__.py
rename to {{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/__init__.py
index eb816d6c5da25707d3aee4c16389cc5e96a7ad16..35d0142800c927ba97b4c350de181c8d48f45f43 100644
--- a/my_awesome_app/__init__.py
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/__init__.py
@@ -1,8 +1,8 @@
-""" My Awesome Package """
+""" {{cookiecutter.project_name}} """
try:
from importlib import metadata
except ImportError: # for Python<3.8
import importlib_metadata as metadata
-__version__ = metadata.version("my-awesome-app")
+__version__ = metadata.version("{{cookiecutter.project_slug}}")
diff --git a/my_awesome_app/cool_module.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/cool_module.py
similarity index 100%
rename from my_awesome_app/cool_module.py
rename to {{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/cool_module.py