feat(project_setup): Initialize project (#1)

Setting up python project files using poetry. A basic environment
is installed including dash for the app that will be implemented
later.

Also contains several dev tools, including pre-commit hooks.

Co-authored-by: Tobias Quadfasel <tobias.loesche@studium.uni-hamburg.de>
Reviewed-on: #1

.pre-commit-config.yaml

@@ -0,0 +1,74 @@
+default_install_hook_types:
+- pre-commit
+- commit-msg
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+  - id: mixed-line-ending
+  - id: check-yaml
+  - id: sort-simple-yaml
+  - id: check-added-large-files
+
+- repo: https://github.com/psf/black
+  rev: 24.4.2
+  hooks:
+  - id: black
+    language_version: python3.12
+    args:
+    - --config=pyproject.toml
+
+- repo: https://github.com/PyCQA/isort
+  rev: 5.13.2
+  hooks:
+  - id: isort
+    args: ["--profile", "black", "--filter-files"]
+
+- repo: https://github.com/PyCQA/flake8
+  rev: 7.0.0
+  hooks:
+  - id: flake8
+    language_version: python3.12
+    args:
+    - --max-line-length=100
+    - --extend-ignore=E203
+
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.10.0
+  hooks:
+  - id: mypy
+    additional_dependencies: [
+      types-requests,
+    ]
+    args:
+    - --config=pyproject.toml
+
+- repo: https://github.com/PyCQA/docformatter
+  rev: v1.7.5
+  hooks:
+  - id: docformatter
+    additional_dependencies: [tomli]
+    args: [--in-place, --black]
+
+- repo: https://github.com/numpy/numpydoc
+  rev: v1.7.0
+  hooks:
+  - id: numpydoc-validation
+
+- repo: https://github.com/JangasCodingplace/commit-prefix-pre-commit
+  rev: v0.0.3-beta
+  hooks:
+  - id: commit-prefix
+    args:
+      - --allow-main=true
+    stages: [ commit-msg ]
+
+- repo: https://github.com/compilerla/conventional-pre-commit
+  rev: v3.2.0
+  hooks:
+  - id: conventional-pre-commit
+    stages: [ commit-msg ]
+    args: [ ]

pyproject.toml

@@ -0,0 +1,52 @@
+[tool.poetry]
+name = "avacon-app"
+version = "0.1.0"
+description = ""
+authors = ["Tobias Quadfasel <tobias.quadfasel@protonmail.com>"]
+readme = "README.md"
+packages = [{include = "app"}]
+
+[tool.black]
+line-length = 100
+
+[tool.mypy]
+ignore_missing_imports = true
+
+[tool.numpydoc_validation]
+checks = [
+    "all",   # report on all checks, except the below
+    "EX01",
+    "SA01",
+    "ES01",
+    "GL01",
+    "RT01",
+    "RT02",
+    "GL08",
+]
+
+[tool.docformatter]
+wrap-summaries = 100
+
+[tool.poetry.dependencies]
+python = "^3.10"
+plotly = "^5.23.0"
+dash = "^2.17.1"
+
+[tool.poetry.group.docs.dependencies]
+mkdocs = "^1.6.0"
+mkdocs-material = "^9.5.33"
+numpydoc-validation = "^0.1.0"
+
+[tool.poetry.group.dev.dependencies]
+flake8 = "^7.1.1"
+mypy = "^1.11.2"
+isort = "^5.13.2"
+python-dotenv = "^1.0.1"
+black = "^24.8.0"
+pre-commit = "^3.8.0"
+pytest = "^8.3.2"
+types-requests = "^2.32.0.20240712"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"