Merge branch 'Konsti_isntallation_description' into Konsti_CI

README.md

@@ -1,2 +1,14 @@
 # papyrus
-Record your models.
+Unveiling how neural networks learn.  
+
+Just as the invention of papyrus revolutionized the preservation of human thoughts, 
+*papyrus* will give the ability to record the inner mechanisms of artificial neural networks.
+
+In particular, *papyrus* is an open-source Python library that provides a simple interface to record and store states and properties of neural networks during training.
+
+## Installation
+```bash
+git clone https://github.com/zincware/papyrus.git
+cd papyrus
+pip install .
+```

papyrus/__init__.py

@@ -1,14 +1,8 @@
-[build-system]
-requires = ["setuptools", "setuptools-scm"]
-build-backend = "setuptools.build_meta"
+"""
+Papyrus
+=======
+Papyrus is a simple, lightweight Python library for recording neural learning. 
 
-[project]
-name = "my_package"
-authors = [
-    {name = "Example Author", email = "[email protected]"}
-]
-description = "package description"
-version = "0.0.1"
-readme = "README.md"
-requires-python = ">=3.10"
-dependencies = {file = ["requirements.txt"]}
+Summary
+-------
+"""

pyproject.toml

@@ -0,0 +1,17 @@
+[build-system]
+requires = ["setuptools >= 61.0", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "papyrus"
+authors = [
+    {name = "Samuel Tovey", email = "[email protected]"},
+    {name = "Konstantin Nikolaou", email = "[email protected]"},
+]
+description = "Like our ancestors started capturing their thoughts on papyrus, with this package you can capture the inner workings of artificial neural networks."
+readme = "README.md"
+requires-python = ">=3.11"
+keywords = ["neural networks", "artificial intelligence"]
+license = {text = "BSD-3-Clause"}
+
+version = "0.0.1"

setup.cfg

@@ -0,0 +1,24 @@
+
+[options]
+packages = find:
+
+install_requires =
+    numpy
+
+[options.extras_require]
+dev =
+    isort>=5.13.2
+    black>=24.4.0
+    pytest>=8.1.1
+    flake8>=7.0.0
+    pre_commit>=3.7.0
+
+[flake8]
+max-line-length = 88
+
+[black]
+line-length = 88
+
+[isort]
+profile = black
+multi_line_output = 3