Basic skeleton for building the package

.github/workflows/ci.yaml

@@ -0,0 +1,34 @@
+name: ci 
+on:
+  push:
+    branches:
+      - master 
+      - main
+      - dev
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: ~/.cache 
+          restore-keys: |
+            mkdocs-material-
+      - run: |
+          pip install mkdocs-material
+          pip install mkdocstrings
+          pip install pymdown-extensions
+          pip install mkdocs-mermaid2-plugin 
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -1,9 +1,14 @@
 .snakemake/
 Logs
 __pycache__**
-examples/Results/
-examples/results/
-examples/Dataset/reads/*gz
+data/reads/*gz
 resources/
 *DS_store
 .gitignore
+dist/
+Deploy/
+Test/
+config/*yaml
+!config/results_catalogue.yaml
+*Results/
+MMAseq_Test/*