Add some default project files

Author: tmaegel

.pre-commit-config.yaml

@@ -0,0 +1,71 @@
+---
+exclude: (^static/|^staticfiles/|^manage.py|^setup.py|^instance)
+fail_fast: true
+
+repos:
+  - repo: "https://github.com/pre-commit/pre-commit-hooks"
+    rev: "v4.1.0"
+    hooks:
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-byte-order-marker
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: pretty-format-json
+        args: ["--autofix", "--indent=4", "--no-sort-keys"]
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-yaml
+      - id: check-json
+      - id: check-toml
+      - id: check-xml
+      - id: requirements-txt-fixer
+      - id: debug-statements
+      - id: destroyed-symlinks
+      - id: detect-private-key
+      # - id: end-of-file-fixer
+      - id: fix-encoding-pragma
+        args: ["--pragma", "# coding=utf-8"]
+      - id: trailing-whitespace
+
+  - repo: "https://github.com/psf/black"
+    rev: "22.3.0"
+    hooks:
+      - id: black
+
+  - repo: "https://github.com/PyCQA/isort"
+    rev: "5.10.1"
+    hooks:
+      - id: isort
+
+  - repo: "https://github.com/PyCQA/flake8"
+    rev: "4.0.1"
+    hooks:
+      - id: flake8
+
+  - repo: local
+    hooks:
+      - id: pylint
+        name: pylint
+        entry: pylint
+        language: system
+        types: [python]
+
+      - id: pytest
+        name: pytest
+        stages: [commit]
+        language: system
+        entry: coverage run -m pytest
+        types: [python]
+        always_run: true
+        pass_filenames: false
+
+      - id: pytest-cov
+        name: pytest
+        stages: [commit]
+        language: system
+        entry: coverage report
+        types: [python]
+        always_run: true
+        pass_filenames: false

AUTHORS.md

@@ -0,0 +1,9 @@
+# Authors
+
+## Development Lead
+
+- Toni Mägel <[email protected]>
+
+## Contributors
+
+None yet. Why not be the first?

CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.0.1] - YYY-MM-DD
+
+tbd...
+
+### Added
+
+- Intiial release
+
+[unreleased]: https://github.com/tmaegel/pysurvive/compare/v0.0.1...HEAD
+[0.0.1]: https://github.com/tmaegel/pysurvive/releases/tag/v0.0.1

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022, Toni Mägel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,19 @@
+SRC_PATH = src
+
+run:
+	python $(SRC_PATH)/main.py
+
+test:
+	coverage run -m pytest
+	coverage report
+
+tox:
+	tox -e py39
+
+lint:
+	python -m flake8
+	pylint $(SRC_PATH)
+	python -m mypy .
+
+pre-commit:
+	pre-commit run --all-files