Merge pull request #168 from coding-for-reproducible-research/update_requirements_pyproject

Update repo for pyproject.yml with requirements.txt

Author: liamjberrisford

.github/workflows/build-book.yml

@@ -18,21 +18,25 @@ jobs:
       with:
         python-version: 3.11
 
+    - name: Install Poetry
+      run: |
+        curl -sSL https://install.python-poetry.org | python3 -
+
     - name: Install dependencies
       run: |
-        pip install -r requirements.txt
+        poetry install
 
     # (optional) Cache your executed notebooks between runs
     - name: Cache executed notebooks
       uses: actions/cache@v4
       with:
         path: _build/.jupyter_cache
-        key: jupyter-book-cache-${{ hashFiles('requirements.txt') }}
+        key: jupyter-book-cache-${{ hashFiles('pyproject.toml') }}
 
     # Build the book
     - name: Build the book
       run: |
-        jupyter-book build .
+        poetry run jupyter-book build .
 
     # Always upload logs, even if build succeeds
     - name: Upload error logs

.github/workflows/deploy-book.yml

@@ -25,21 +25,25 @@ jobs:
       with:
         python-version: 3.11
 
+    - name: Install Poetry
+      run: |
+        curl -sSL https://install.python-poetry.org | python3 -
+
     - name: Install dependencies
       run: |
-        pip install -r requirements.txt
+        poetry install
 
     # (optional) Cache your executed notebooks between runs
     - name: Cache executed notebooks
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: _build/.jupyter_cache
-        key: jupyter-book-cache-${{ hashFiles('requirements.txt') }}
+        key: jupyter-book-cache-${{ hashFiles('pyproject.toml') }}
 
     # Build the book
     - name: Build the book
       run: |
-        jupyter-book build .
+        poetry run jupyter-book build .
 
     # Upload the book's HTML as an artifact
     - name: Upload artifact

README.md

@@ -30,7 +30,7 @@ There are also several files within the root directory; these include:
 - **_toc.yml**: This file organizes the structure and overall navigation of the content of the Jupyter Book that is built.
 - **CITATION.cff**: Provides citation information for the CfRR website, and the course content aggregated throughout the website. 
 - **references.bib**: Used to store bibliographic references throughout all of the content on the website. 
-- **requirements.txt**: A file that specifies the dependencies of the Python kernel used in the website.  
+- **pyproject.yml**: A file that specifies the dependencies of the Python kernel used in the website.
 
 ## Contributing
 

pyproject.toml

@@ -0,0 +1,22 @@
+[tool.poetry]
+name = "Coding for Reproducible Research Courses"
+version = "0.1.0"
+description = "Coding for Reproducible Research: Courses and Training Materials"
+authors = ["CfRR Contributors"]
+repository = "https://github.com/coding-for-reproducible-research/CfRR_Courses"
+homepage = "https://coding-for-reproducible-research.github.io/CfRR_Courses/home_page.html"
+
+[tool.poetry.dependencies]
+python = "^3.11"  # or your desired Python version
+numpy = "^1.26.4"
+pandas = "*"
+jupyter-book = "*"
+ghp-import = "*"
+jupyterquiz = "*"
+matplotlib = "*"
+scikit-learn = "*"
+pyvis = "*"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"