feat: Add project files

CONTRIBUTING.md

@@ -0,0 +1,154 @@
+<!--
+ ~ Copyright DB Netz AG and contributors
+ ~ SPDX-License-Identifier: Apache-2.0
+ -->
+
+# Contributing
+
+Thanks for your interest in our project. Contributions are always welcome!
+
+We are committed to fostering a welcoming, respectful, and harassment-free
+environment. Be kind!
+
+If you have questions, ideas or want to report a bug, feel free to [open an
+issue]. Or go ahead and [open a pull request] to contribute code. In order to
+reduce the burden on our maintainers, please make sure that your code follows
+our style guidelines outlined below.
+
+<!-- prettier-ignore -->
+[open an issue]: https://github.com/DSD-DBS/capella-git-hooks/issues
+[open a pull request]: https://github.com/DSD-DBS/capella-git-hooks/pulls
+
+## Developing
+
+We recommend that you
+[develop inside of a virtual environment](README.md#installation). After you
+have set it up, simply run the unit tests to verify that everything is set up
+correctly:
+
+```sh
+pytest
+```
+
+We additionally recommend that you set up your editor / IDE as follows.
+
+- Indent with 4 spaces per level of indentation
+
+- Maximum line length of 79 (add a ruler / thin line / highlighting / ...)
+
+- _If you use Visual Studio Code_: Consider using a platform which supports
+  third-party language servers more easily, and continue with the next point.
+
+  Otherwise, set up the editor to run `black`, `pylint` and `mypy` when saving.
+  To enable automatic import sorting with `isort`, add the following to your
+  `settings.json`:
+
+  ```json
+  "[python]": {
+      "editor.codeActionsOnSave": {
+          "source.organizeImports": true
+      }
+  }
+  ```
+
+  Note that the Pylance language server is not recommended, as it occasionally
+  causes false-positive errors for perfectly valid code.
+
+- _If you do not use VSC_: Set up your editor to use the [python-lsp-server],
+  and make sure that the relevant plugins are installed. You can install
+  everything that's needed into the virtualenv with pip:
+
+  [python-lsp-server]: https://github.com/python-lsp/python-lsp-server
+
+  ```sh
+  pip install "python-lsp-server[pylint]" python-lsp-black pyls-isort pylsp-mypy
+  ```
+
+  This will provide as-you-type linting as well as automatic formatting on
+  save. Language server clients are available for a wide range of editors, from
+  Vim/Emacs to PyCharm/IDEA.
+
+## Code style
+
+We base our code style on a modified version of the
+[Google style guide for Python code](https://google.github.io/styleguide/pyguide.html).
+The key differences are:
+
+- **Docstrings**: The [Numpy style guide] applies here.
+
+  [numpy style guide]:
+    https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard
+
+  When writing docstrings for functions, use the imperative style, as per
+  [PEP-257]). For example, write "Do X and Y" instead of "Does X and Y".
+
+  [pep-257]: https://peps.python.org/pep-0257/
+
+- **Overridden methods**: If the documentation did not change from the base
+  class (i.e. the base class' method's docstring still applies without
+  modification), do not add a short docstring á la "See base class". This lets
+  automated tools pick up the full base class docstring instead, and is
+  therefore more useful in IDEs etc.
+
+- **Linting**: Use [pylint] for static code analysis, and [mypy] for static
+  type checking.
+
+  [pylint]: https://github.com/PyCQA/pylint
+  [mypy]: https://github.com/python/mypy
+
+- **Formatting**: Use [black] as code auto-formatter. The maximum line length
+  is 79, as per [PEP-8]. This setting should be automatically picked up from
+  the `pyproject.toml` file. The reason for the shorter line length is that it
+  avoids wrapping and overflows in side-by-side split views (e.g. diffs) if
+  there's also information displayed to the side of it (e.g. a tree view of the
+  modified files).
+
+  [black]: https://github.com/psf/black
+  [pep-8]: https://www.python.org/dev/peps/pep-0008/
+
+  Be aware of the different line length of 72 for docstrings. We currently do
+  not have a satisfactory solution to automatically apply or enforce this.
+
+  Note that, while you're encouraged to do so in general, it is not a hard
+  requirement to break up long strings into smaller parts. Additionally, never
+  break up strings that are presented to the user in e.g. log messages, as that
+  makes it significantly harder to grep for them.
+
+  Use [isort] for automatic sorting of imports. Its settings should
+  automatically be picked up from the `pyproject.toml` file as well.
+
+  [isort]: https://github.com/PyCQA/isort
+
+- **Typing**: We do not make an exception for `typing` imports. Instead of
+  writing `from typing import SomeName`, use `import typing as t` and access
+  typing related classes like `t.TypedDict`.
+
+  <!-- prettier-ignore -->
+
+  Use the new syntax and classes for typing introduced with Python 3.10.
+
+  - Instead of `t.Tuple`, `t.List` etc. use the builtin classes `tuple`, `list`
+    etc.
+  - For classes that are not builtin (e.g. `Iterable`),
+    `import collections.abc as cabc` and then use them like `cabc.Iterable`.
+  - Use [PEP-604-style unions], e.g. `int | float` instead of
+    `t.Union[int, float]`.
+  - Use `... | None` (with `None` always as the last union member) instead of
+    `t.Optional[...]` and always explicitly annotate where `None` is possible.
+
+  [pep-604-style unions]: https://www.python.org/dev/peps/pep-0604/
+
+- **Python style rules**: For conflicting parts, the [Black code style] wins.
+  If you have set up black correctly, you don't need to worry about this though
+  :)
+
+  [black code style]:
+    https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html
+
+- When working with `dict`s, consider using `t.TypedDict` instead of a more
+  generic `dict[str, float|int|str]`-like annotation where possible, as the
+  latter is much less precise (often requiring additional `assert`s or
+  `isinstance` checks to pass) and can grow unwieldy very quickly.
+
+- Prefer `t.NamedTuple` over `collections.namedtuple`, because the former uses
+  a more convenient `class ...:` syntax and also supports type annotations.

LICENSES/.license_header.txt

@@ -0,0 +1,2 @@
+Copyright DB Netz AG and contributors
+SPDX-License-Identifier: Apache-2.0

LICENSES/Apache-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 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.