Preparing package for SIMPLE Archive (#562)

* Preparing package for SIMPLE Archive

* Fixing to include test, updates to toml and gitignore

* Documentation update

.devcontainer/devcontainer.json

@@ -13,7 +13,7 @@
 	"forwardPorts": [5432],
 
 	// Use 'postCreateCommand' to run commands after the container is created.
-	"postCreateCommand": "pip install -r requirements.txt",
+	"postCreateCommand": "pip install -e .",
 	// python scripts/tutorials/generate_database.py sqlite
 	// python scripts/tutorials/generate_database.py postgres postgres://postgres@localhost:5432
 

.github/workflows/python-app.yml

@@ -24,7 +24,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
+        pip install .[test]
 
     - name: Test with pytest
       run: |

.github/workflows/scheduled-tests.yml

@@ -24,7 +24,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
+        pip install .[test]
 
     - name: Test with pytest
       run: |

.gitignore

@@ -8,5 +8,7 @@
 .ds_store
 *.code-workspace
 .ipynb_checkpoints
-
+*.egg-info
+build/
+simple/version.py
 

README.md

@@ -31,7 +31,7 @@ We recommend using a conda environment to handle python dependencies. The follow
     ```bash
     conda  create -n "simple-db" python=3.10
     conda activate simple-db
-    pip install -r requirements.txt
+    pip install -e .
     ```
 
 3. In Python, connect a database file `SIMPLE.sqlite` as a Database object called `db` and recreate the database using the JSON files in the `data/` directory. Run these commands from within Python. 

pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = [
+  "setuptools>=75",
+  "setuptools_scm",
+  ]
+build-backend = "setuptools.build_meta"
+
+
+[project]
+name = "simple"
+description = "SIMPLE Archive Software"
+dynamic = ["version"]
+readme = "README.md"
+license = {file = "LICENSE"}
+authors = [
+    {name = "Kelle Cruz", email = "[email protected]"},
+    {name = "David Rodriguez", email = "[email protected]"},
+]
+requires-python = ">= 3.10"
+dependencies = [
+    "astrodbkit",
+    "astrodb_utils",
+    "ads",
+    "matplotlib",
+]
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+]
+
+[project.urls]
+Repository = "https://github.com/SIMPLE-AstroDB/SIMPLE-db"
+Documentation = "https://github.com/SIMPLE-AstroDB/SIMPLE-db/documentation"
+
+
+[tool.setuptools]
+packages = ["simple"]
+
+[tool.setuptools_scm]
+write_to = "simple/version.py"

simple/__init__.py

@@ -0,0 +1,3 @@
+from .version import version as __version__
+
+__all__ = ["__version__"]