commit d3c22673c0fdcd1f599f0dfef042ca1acaeb60e5 Author: ph Date: Wed Jul 17 23:31:45 2024 +0200 basic package structure diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3570dc6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,25 @@ +# Default ignored files +/shelf/ +/workspace.xml + +# Byte-compiled / optimized / DLL files +__pycache__/ + +# Distribution / packaging +build/ +dist/ +*.egg-info/ +.eggs/ + +# Environments +venv/ + +# Jupyter Notebook +.ipynb_checkpoints + +# Editor directories and files +.idea/ + +# OS-specific files +.DS_Store +Thumbs.db diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..13315b8 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,6 @@ +The material in this repository is released under the +CC Attribution-Share Alike 4.0 International +license. + +Full license text available at +https://creativecommons.org/licenses/by-sa/4.0/ \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..3178ee8 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# Brewing Package + +The package contains the materials for a lecture on organising code + +A README can explain in detail what the package does and how to use it i.e. how to install it. +It is often written in Markdown. + + + diff --git a/notebooks/import_from_package.py b/notebooks/import_from_package.py new file mode 100644 index 0000000..e69de29 diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..fb1bc1b --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,15 @@ +[project] +name = "brewing" +version = "0.1.0" +description = "a python package for brewing potions" +authors = [{ name = "H. Granger", email = "h.granger@hogwarts.ac.uk" }] +license = { file = "LICENSE.txt" } +requires-python = ">=3.8" +dependencies = ["numpy >= 1.14.0", "pytest >= 3.0.0"] + +[project.urls] +"Homepage" = "https://git.aspp.school/ASPP/2024-heraklion-ODD" + +[build-system] +requires = ["setuptools", "setuptools-scm"] +build-backend = "setuptools.build_meta" diff --git a/src/brewing/__init__.py b/src/brewing/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/brewing/import_locally.py b/src/brewing/import_locally.py new file mode 100644 index 0000000..e69de29