Basic package structure (#2)

Closes #1

README.md

@@ -1,2 +1,44 @@
 # pytopotoolbox
-Python interface to TopoToolbox
+
+Python interface to TopoToolbox.
+
+## Guide
+
+Temporary guide for the functionality of the package. For Windows replace "python3" with "py".
+
+### Generate distribution archives
+
+Generates a .whl and .tar.gz which then can be used to install package with pip.
+These Files can be distributed with PyPi or downloaded directly.
+
+```bash
+cd path/to/pytopotoolbox
+python3 -m pip install --upgrade build
+python3 -m build
+```
+
+### Installing distribution archives
+
+Use "--force-reinstall" to overwrite previous install.
+
+```bash
+pip install dist_name.whl
+```
+
+### Installing from repository
+
+If want to install the package directly from the repository without first generating a ".whl" file.
+
+```bash
+cd path/to/pytopotoolbox
+pip install .
+```
+
+### Unittest
+
+How to run a single unittest:
+
+```bash
+cd path/to/pytopotoolbox
+python3 -m tests.filename 
+```

pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "topotoolbox"
+version = "3.0.1"
+authors = [
+    {name="Wolfgang Schwanghart", email="w.schwanghart@geo.uni-potsdam.de"},
+    {name="Dirk Scherler", email="scherler@fz-potsdam.de"},
+    {name="Will Kearney", email="william.kearney@uni-potsdam.de"},
+    {name="Theo Bringezu", email="theophil.bringezu@uni-potsdam.de"}
+]
+description = "Python interface to TopoToolbox."
+readme = "README.md"
+license = { file = "LICENSE" }
+dependencies = [
+    "numpy",
+    "matplotlib"
+]
+requires-python = ">=3.8"
+keywords = ["TopoToolbox"]
+classifiers = []
+
+[project.urls]
+Homepage = "https://topotoolbox.github.io"
+Repository = "https://github.com/TopoToolbox/pytopotoolbox"
+Issues = "https://github.com/TopoToolbox/pytopotoolbox/issues"

src/topotoolbox/__init__.py

@@ -0,0 +1 @@
+from .placeholder import example

src/topotoolbox/placeholder.py

@@ -0,0 +1,2 @@
+def example(input):
+    return str(input) + " example"

tests/test.py

@@ -0,0 +1,4 @@
+import topotoolbox
+
+print(dir(topotoolbox))
+print(topotoolbox.example("test"))

tests/unittest.py

@@ -0,0 +1,12 @@
+import unittest
+from src.topotoolbox.placeholder import example
+
+class TestPlaceholder(unittest.TestCase):
+    def test_example1(self):
+        self.assertEqual(example("test"), "test example", "failed unittest")
+
+    def test_example2(self):
+        self.assertEqual(example(""), " example", "failed unittest")
+
+if __name__ == '__main__':
+    unittest.main()