Initial commit

.gitignore

@@ -0,0 +1,78 @@
+*.py[cod]
+__pycache__
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+.eggs
+parts
+bin
+var
+sdist
+wheelhouse
+develop-eggs
+.installed.cfg
+lib
+lib64
+venv*/
+pyvenv*/
+pip-wheel-metadata/
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+.coverage.*
+.pytest_cache/
+nosetests.xml
+coverage.xml
+htmlcov
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+.idea
+*.iml
+*.komodoproject
+
+# Complexity
+output/*.html
+output/*/index.html
+
+# Sphinx
+docs/_build
+
+.DS_Store
+*~
+.*.sw[po]
+.build
+.ve
+.env
+.cache
+.pytest
+.benchmarks
+.bootstrap
+.appveyor.token
+*.bak
+**/pytest.log
+
+# Mypy Cache
+.mypy_cache/
+
+# Jupyter notebook checkpoints
+.ipynb_checkpoints/
+
+# Template specific
+local.dockerfile  # only for local pycharm use

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+---
+default_language_version:
+  python: python3
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: name-tests-test
+        args: [--pytest-test-first]
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.14
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024, Gunnhild Svandal Presthus
+
+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 (including the next paragraph) 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.

README.md

@@ -0,0 +1,49 @@
+# data_viz_pyladies
+
+An example project
+
+## Development
+
+Dependencies for the project are managed with poetry. To install all dependencies, run:
+
+```shell
+poetry install
+```
+
+It's recommended to install and use Pre-commit hooks to ensure code quality. Pre-commit can for
+example be installed with pip or [pipx](https://pypa.github.io/pipx/installation/) (recommended):
+
+It's recommended to install and use Pre-commit hooks to ensure code quality. Pre-commit is one of
+the dev-dependencies of this project, so it was installed when you entered the command above, but
+the hooks still need to be installed with the following command:
+
+```shell
+poetry run pre-commit install
+```
+
+After installation, Pre-commit will run a series of checks on each commit. These checks are defined
+in `.pre-commit-config.yaml`. If Pre-commit finds an issue, it will usually (depending on the hook)
+fix it automatically. You will have to add the changes to the staging area and commit again:
+
+```shell
+git add .
+git commit
+```
+
+Pre-commit can also be run manually:
+
+```shell
+poetry run pre-commit run --all-files
+```
+
+It's a good idea to update the Pre-commit hooks regularly:
+
+```shell
+poetry run pre-commit autoupdate
+```
+
+Tests can be run with pytest:
+
+```shell
+poetry run pytest
+```