Skip to content

Commit

Permalink
Update and shorten all copyright notices #33
Browse files Browse the repository at this point in the history
  • Loading branch information
Ludee committed Aug 25, 2023
1 parent 91a8cc5 commit 8036597
Show file tree
Hide file tree
Showing 15 changed files with 38 additions and 35 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SPDX-FileCopyrightText: : Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
# SPDX-FileCopyrightText: : Ludwig Hülk (Ludee) © Reiner Lemoine Institut
# SPDX-License-Identifier: CC0-1.0
# source: https://github.com/github/gitignore/blob/main/Python.gitignore
# Source: https://github.com/github/gitignore/blob/main/Python.gitignore

# Byte-compiled / optimized / DLL files
__pycache__/
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: : Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
# SPDX-FileCopyrightText: : Ludwig Hülk (Ludee) © Reiner Lemoine Institut
# SPDX-License-Identifier: CC0-1.0

# exclude webdevelopement build artefacts
Expand Down
10 changes: 5 additions & 5 deletions .reuse/dep5
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ Upstream-Contact: Ludwig Hülk <https://github.com/Ludee>
Source: https://github.com/rl-institut/super-repo

Files: .github/*
Copyright: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
Jonas Huber © Reiner Lemoine Institut <https://github.com/jh-RLI>
Copyright: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
Jonas Huber (jh-RLI) © Reiner Lemoine Institut
License: CC0-1.0

Files: docs/*
Copyright: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
Jonas Huber © Reiner Lemoine Institut <https://github.com/jh-RLI>
Copyright: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
Jonas Huber (jh-RLI) © Reiner Lemoine Institut
License: CC-BY-4.0

Files: README.rst
Copyright: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
Copyright: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
License: MIT
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
SPDX-License-Identifier: CC0-1.0
-->

Expand Down
11 changes: 8 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
# SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
# SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
# SPDX-License-Identifier: CC0-1.0

cff-version: 1.2.0
message: "If you use this software, please cite it using these metadata."
authors:
- family-names: "Hülk"
given-names: "Ludwig"
alias: "@Ludee"
alias: "Ludee"
affiliation: "Reiner Lemoine Institut"
orcid: "https://orcid.org/0000-0003-4655-2321"
- family-names: "Huber"
given-names: "Jonas"
alias: "jh-rli"
affiliation: "Reiner Lemoine Institut"
orcid: "https://orcid.org/0000-0002-6234-0751"
title: "Super Repo"
type: software
license: MIT
version: 0.2.0
doi:
doi: null
date-released: 2023-08-11
url: "https://github.com/rl-institut/super-repo/"
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
SPDX-License-Identifier: MIT
[Homepage]: https://rl-institut.github.io/super-repo/
Expand Down
2 changes: 1 addition & 1 deletion RELEASE_PROCEDURE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
SPDX-License-Identifier: MIT
[Homepage]: https://rl-institut.github.io/super-repo/
Expand Down
2 changes: 1 addition & 1 deletion USERS.cff
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
# SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
# SPDX-License-Identifier: CC0-1.0

cff-version: 1.2.0
Expand Down
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
# SPDX-FileCopyrightText: Jonas Huber © Reiner Lemoine Institut <https://github.com/jh-RLI>
# SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
# SPDX-FileCopyrightText: Jonas Huber (jh-RLI) © Reiner Lemoine Institut
# SPDX-License-Identifier: CC0-1.0

# Project
site_name: Super-Repo Documentation
site_url: https://rl-institut.github.io/super-repo/
site_description: Write your documentation in Markdown and create a static page for your developer and user community
site_description: Documentation of the Super-Repo for scientific software

# Repository
repo_name: rl-institut/super-repo
Expand Down
4 changes: 2 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
# SPDX-FileCopyrightText: Jonas Huber © Reiner Lemoine Institut <https://github.com/jh-RLI>
# SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
# SPDX-FileCopyrightText: Jonas Huber (jh-RLI) © Reiner Lemoine Institut
# SPDX-License-Identifier: MIT

mkdocs
Expand Down
6 changes: 3 additions & 3 deletions super_repo/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Examples for the calculater functionality to demonstrate TDD.
SPDX-FileCopyrightText: Jonas Huber © Reiner Lemoine Institut <https://github.com/jh-RLI>
SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
SPDX-FileCopyrightText: Jonas Huber (jh-RLI) © Reiner Lemoine Institut
SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
SPDX-License-Identifier: MIT
"""
"""
4 changes: 2 additions & 2 deletions super_repo/example_calculator.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
Examples for the calculater functionality to demonstrate TDD.
SPDX-FileCopyrightText: Jonas Huber © Reiner Lemoine Institut <https://github.com/jh-RLI>
SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
SPDX-FileCopyrightText: Jonas Huber (jh-RLI) © Reiner Lemoine Institut
SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
SPDX-License-Identifier: MIT
"""

Expand Down
3 changes: 2 additions & 1 deletion super_repo/example_google.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
SPDX-FileCopyrightText: Copyright (c) 2007-2023 by the Sphinx team
SPDX-License-Identifier: BSD-2-Clause
Source: https://github.com/sphinx-doc/sphinx/blob/master/doc/usage/extensions/example_google.py
https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html
This module demonstrates documentation as specified by the `Google Python
Style Guide`_. Docstrings may extend over multiple lines. Sections are created
Expand Down
5 changes: 1 addition & 4 deletions tests/test_example.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@
Example implementation of common calculater functionality to
demonstrate TDD.
SPDX-FileCopyrightText: 2023 Jonas Huber <@jh-RLI>
SPDX-FileCopyrightText: © Reiner Lemoine Institut
SPDX-FileCopyrightText: Jonas Huber (jh-RLI) © Reiner Lemoine Institut
SPDX-License-Identifier: MIT
"""

Expand Down
10 changes: 5 additions & 5 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# SPDX-FileCopyrightText: Jonas Huber © Reiner Lemoine Institut <https://github.com/jh-RLI>
# SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
# SPDX-FileCopyrightText: Jonas Huber (jh-RLI) © Reiner Lemoine Institut
# SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
# SPDX-License-Identifier: MIT

[tox]
Expand Down Expand Up @@ -44,7 +44,7 @@ commands_pre =
commands =
pytest --cov --cov-report=term-missing --cov-append --cov-config=.coveragerc --hypothesis-show-statistics {posargs}
# after executing the pytest assembles the coverage reports
commands_post =
commands_post =
coverage report
coverage html
coverage xml
Expand Down Expand Up @@ -77,7 +77,7 @@ hang-closing = true
; D407 # Dont know what to do
; D406 # Dont know what to do
; D401 # Not suitable for example docstring names
ignore =
ignore =
W293
W503
D412
Expand Down Expand Up @@ -106,7 +106,7 @@ sections=FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
known_first_party = sampleproject
# you should add here your known thirdparties, it will facilitate
# the job to isort
known_third_party =
known_third_party =
hypothesis
matplotlib
numpy
Expand Down

0 comments on commit 8036597

Please sign in to comment.