Skip to content

Commit 4eab472

Browse files
author
a.pirogov
committed
make the template use more of the template
1 parent a39386d commit 4eab472

20 files changed

Lines changed: 1367 additions & 218 deletions

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,4 +147,4 @@ jobs:
147147
with:
148148
to_github: true
149149
to_test_pypi: false
150-
to_pypi: true
150+
to_pypi: false

.gitlab-ci.yml

Lines changed: 0 additions & 84 deletions
This file was deleted.

.gitlab/issue_templates/Default.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

.gitlab/issue_templates/bug_report.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

.gitlab/issue_templates/feature_request.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

.pre-commit-config.yaml

Lines changed: 40 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1+
exclude: "^{{ cookiecutter.*" # <-- added
2+
# ---- copy from template below ----
13
# See https://pre-commit.com for more information
24
# See https://pre-commit.com/hooks.html for more hooks
3-
exclude: "^{{ cookiecutter.*"
45
repos:
6+
7+
# Various general + format-specific helpers
58
- repo: https://github.com/pre-commit/pre-commit-hooks
69
rev: v4.4.0
710
hooks:
@@ -10,6 +13,7 @@ repos:
1013
- id: mixed-line-ending
1114
args: [--fix=lf]
1215
- id: check-yaml
16+
exclude: 'mkdocs.yml'
1317
- id: check-toml
1418
- id: check-json
1519
- id: check-ast
@@ -26,23 +30,51 @@ repos:
2630
rev: '5.12.0'
2731
hooks:
2832
- id: isort
29-
args: ["--profile", "black"]
33+
args: ['--profile', 'black']
3034
- repo: https://github.com/ambv/black
3135
rev: '23.1.0'
3236
hooks:
3337
- id: black
38+
- repo: https://github.com/PyCQA/autoflake
39+
rev: v2.1.1
40+
hooks:
41+
- id: autoflake
42+
43+
# Quality
3444
- repo: https://github.com/pycqa/flake8
3545
rev: '6.0.0'
3646
hooks:
3747
- id: flake8
38-
additional_dependencies: [Flake8-pyproject,flake8-docstrings]
48+
additional_dependencies:
49+
- Flake8-pyproject==1.2.3
50+
- flake8-bugbear==23.3.23
51+
- dlint==0.14.1
52+
- repo: https://github.com/pycqa/pydocstyle
53+
rev: '6.3.0'
54+
hooks:
55+
- id: pydocstyle
56+
additional_dependencies: ["tomli==2.0.1"]
57+
files: "^src/"
58+
- repo: https://github.com/econchick/interrogate
59+
rev: "1.5.0"
60+
hooks:
61+
- id: interrogate
62+
files: "^src/"
3963
- repo: https://github.com/pre-commit/mirrors-mypy
4064
rev: 'v1.1.1'
4165
hooks:
4266
- id: mypy
4367
args: [--no-strict-optional, --ignore-missing-imports]
4468
# NOTE: you might need to add some deps here:
4569
additional_dependencies: []
70+
- repo: https://github.com/PyCQA/bandit
71+
rev: '1.7.5'
72+
hooks:
73+
- id: bandit
74+
args: ['-q', '-c', 'pyproject.toml']
75+
additional_dependencies: [ '.[toml]' ]
76+
77+
# Metadata
4678
- repo: https://github.com/citation-file-format/cff-converter-python
4779
rev: '44e8fc9'
4880
hooks:
@@ -52,11 +84,8 @@ repos:
5284
hooks:
5385
- id: reuse
5486

55-
# - repo: local
56-
# hooks:
57-
# - id: update-codemeta
58-
# name: update-codemeta
59-
# language: python
60-
# additional_dependencies: ["codemetapy==2.4.1"]
61-
# entry: update-codemeta codemeta.json
62-
# files: ^pyproject.toml$
87+
- repo: https://github.com/Materials-Data-Science-and-Informatics/dev-utils
88+
rev: 'v0.1.0'
89+
hooks:
90+
- id: update-codemeta
91+
files: ^pyproject.toml$

.reuse/dep5

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
22
Upstream-Name: fair-python-cookiecutter
33
Upstream-Contact: Anton Pirogov <a.pirogov@fz-juelich.de>
4-
Source: https://jugit.fz-juelich.de/ias-9/metador/ias9-dev-general/fair-python-cookiecutter
5-
6-
Files: .gitignore pyproject.toml poetry.lock .pre-commit-config.yaml codemeta.json CITATION.cff README.md .gitlab-ci.yml .gitlab/* .github/*
7-
Copyright: $YEAR $NAME <$CONTACT>
8-
License: Unlicense
4+
Source: https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter
95

106
Files: {{ cookiecutter*
11-
Copyright: $YEAR $NAME <$CONTACT>
12-
License: Unlicense
7+
Copyright: 2023 Forschungszentrum Jülich GmbH - Institute for Materials Data Science and Informatics (IAS9) - Stefan Sandfeld <s.sandfeld@fz-juelich.de>
8+
License: CC0-1.0
9+
10+
Files: .gitignore pyproject.toml poetry.lock .pre-commit-config.yaml codemeta.json CITATION.cff README.md RELEASE_NOTES.md CHANGELOG.md CODE_OF_CONDUCT.md AUTHORS.md CONTRIBUTING.md .github/* mkdocs.yml docs/*
11+
Copyright: 2023 Forschungszentrum Jülich GmbH - Institute for Materials Data Science and Informatics (IAS9) - Stefan Sandfeld <s.sandfeld@fz-juelich.de>
12+
License: CC0-1.0
1313

1414
Files: tests/* hooks/*
15-
Copyright: $YEAR $NAME <$CONTACT>
15+
Copyright: 2023 Forschungszentrum Jülich GmbH - Institute for Materials Data Science and Informatics (IAS9) - Stefan Sandfeld <s.sandfeld@fz-juelich.de>
1616
License: MIT
17-

AUTHORS.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Authors and Contributors
2+
3+
**Main authors** are persons whose contributions significantly shaped
4+
the state of the software at some point in time.
5+
6+
**Additional contributors** are persons who are not main authors,
7+
but contributed non-trivially to this project,
8+
e.g. by providing smaller fixes and enhancements to the code and/or documentation.
9+
10+
Of course, this is just a rough overview and categorization.
11+
For a more complete overview of all contributors and contributions,
12+
please inspect the git history of this repository.
13+
14+
## Main Authors
15+
16+
- Anton Pirogov (
17+
[E-Mail](mailto:a.pirogov@fz-juelich.de),
18+
[ORCID](https://orcid.org/0000-0002-5077-7497)
19+
): original author
20+
21+
## Additional Contributors
22+
23+
<!--
24+
- Name (E-mail, ORCID):
25+
Summary of contribution
26+
-->
27+
28+
... maybe **[you](https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter/main/contributing)**?

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changelog
2+
3+
Here we provide notes that summarize the most important changes in each released version.
4+
5+
Please consult the changelog to inform yourself about breaking changes and security issues.
6+
7+
## [v0.1.0](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter/tree/v0.1.0) <small>(2023-05-11)</small> { id="0.1.0" }
8+
9+
* First release
10+

CITATION.cff

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
cff-version: 1.2.0
2+
type: software
3+
message: If you use this software, please cite it using this metadata.
4+
5+
title: "fair-python-cookiecutter"
6+
version: "0.1.0"
7+
abstract: "An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata. "
8+
repository-code: "https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter"
9+
license: "MIT"
10+
keywords: [
11+
"fair",
12+
"metadata",
13+
"python",
14+
"cookiecutter",
15+
"template"
16+
]
17+
18+
authors:
19+
- family-names: "Pirogov"
20+
given-names: "Anton"
21+
email: "a.pirogov@fz-juelich.de"
22+
orcid: "https://orcid.org/0000-0002-5077-7497"
23+
affiliation: "Forschungszentrum Jülich GmbH - Institute for Materials Data Science and Informatics (IAS9)"
24+

0 commit comments

Comments
 (0)