basic package structure

.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

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/

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.
+
+
+

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"