Make auto-generated citation file

Author: jorgensd

cookiecutter.json

@@ -6,6 +6,7 @@
   "repository_name": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}",
   "module_name": "{{cookiecutter.repository_name}}",
   "project_short_description": "Tools ensuring reproducible and standarized Python packaging.",
+  "orcid": "ABCD-ABCD-ACBD-ABCD",
   "version": "0.1.0",
   "linting": "y",
   "testing": [

docs/options.md

@@ -7,12 +7,13 @@ The following options are available when using the cookiecutter:
 4. __project\_name__: Used in various headers of the documentation
 5. __repository\_name__: Name of the repository
 6. __package\_name__: Name of the python package.
-7. __project\_short\_description__: Usin in `pyproject.toml`
-8. __version__: The initial version of the software.
-9. __linting__: Enable linting, i.e. [mypy](https://scientificcomputing.github.io/reproducibility/part1/typing.html) and [flake8](https://scientificcomputing.github.io/reproducibility/part1/linting.html). This also enables the "Check Formatting" Github action.
-10. __testing__: Choose testing framework. If not `none` it creates a test folder with an initial test. Also adds [optional installation dependencies](https://scientificcomputing.github.io/reproducibility/part1/packaging.html#optional-dependencies) to `pyproject.toml`. Creates a "Test Package" Github action. If `pytest-cov` is chosen, it adds settings to generate a coverage report and publsuh them as a [Github artifact](https://scientificcomputing.github.io/reproducibility/part1/coverage.html).
-10. __use\_argparse__: Makes it possible to run the package as `module_name` or `python -m module_name` with inputs from the command line.
-11. __build\_docs__: Build a webpage with documentation (including a package API).
-12. __use_pre_commit__: Set up [pre-commit hooks](https://pre-commit.com) that will run some tests every time you make a commit.
-13. __docker__: Adds a Dockerfile that includes the module (not including optional dependencies). Adds a [publishing workflow](https://scientificcomputing.github.io/reproducibility/part4/docker.html#github-packages).
-14. __open\_source\_license__: Choose a open source license for your code
+7. __project\_short\_description__: Using in `pyproject.toml`
+8. __orcid__: Your [ORCID](https://en.wikipedia.org/wiki/ORCID) identification number
+9. __version__: The initial version of the software.
+10. __linting__: Enable linting, i.e. [mypy](https://scientificcomputing.github.io/reproducibility/part1/typing.html) and [flake8](https://scientificcomputing.github.io/reproducibility/part1/linting.html). This also enables the "Check Formatting" Github action.
+11. __testing__: Choose testing framework. If not `none` it creates a test folder with an initial test. Also adds [optional installation dependencies](https://scientificcomputing.github.io/reproducibility/part1/packaging.html#optional-dependencies) to `pyproject.toml`. Creates a "Test Package" Github action. If `pytest-cov` is chosen, it adds settings to generate a coverage report and publsuh them as a [Github artifact](https://scientificcomputing.github.io/reproducibility/part1/coverage.html).
+12. __use\_argparse__: Makes it possible to run the package as `module_name` or `python -m module_name` with inputs from the command line.
+13. __build\_docs__: Build a webpage with documentation (including a package API).
+14. __use_pre_commit__: Set up [pre-commit hooks](https://pre-commit.com) that will run some tests every time you make a commit.
+15. __docker__: Adds a Dockerfile that includes the module (not including optional dependencies). Adds a [publishing workflow](https://scientificcomputing.github.io/reproducibility/part4/docker.html#github-packages).
+16. __open\_source\_license__: Choose a open source license for your code

{{cookiecutter.repository_name}}/CITATION.cff

@@ -0,0 +1,15 @@
+{% set names = cookiecutter.full_name.split(' ') -%}
+{% set ns = namespace(given=names[0]) -%}
+{% for name in names[1:-1] -%}
+{% set ns.given = ns.given + " " + name-%}
+{% endfor -%}
+
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "{{names[-1]}}"
+  given-names: "{{ns.given}}"
+  orcid: "https://orcid.org/{{cookiecutter.orcid}}"
+title: "{{cookiecutter.project_name}}"
+version: "{{cookiecutter.version}}"
+date-released: {% now 'utc', '%Y-%m-%d' %}