add pytest install to workflows

shahcompbio · Feb 5, 2025 · e0403a6 · e0403a6
1 parent d27d1eb
commit e0403a6
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/.github/workflows/integration.yaml b/.github/workflows/integration.yaml
@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
       - name: Checkout repository
@@ -30,8 +30,8 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y build-essential python3-dev python3-pip cargo
 
-      - name: Install maturin
-        run: pip install maturin
+      - name: Install pytest
+        run: pip install pytest
 
       - name: Build and Install RustBam
         run: |

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/shahcompbio/rustbam/actions/workflows/integration.yaml/badge.svg)](https://github.com/shahcompbio/rustbam/actions/workflows/integration.yaml)
 
-**rustbam** is a high-performance BAM depth calculator written in **Rust**, with **Python bindings** for fast and efficient genomic data analysis.
+`rustbam` is a high-performance BAM depth calculator written in **Rust**, with **Python bindings** for fast and efficient genomic data analysis.
 
 ## 📦 Installation  
 
@@ -14,6 +14,12 @@ You can install `rustbam` directly with `pip`:
 pip install rustbam
 ```
 
+### **Requirements**
+
+`rustbam` requires **Python ≥3.8** and a compatible Linux environment. Prebuilt wheels are available for most systems, but if you encounter installation issues, ensure your system has **glibc ≥2.17** (manylinux2014 compatibility). To check your version, run `ldd --version`. 
+
+If you need to compile from source, install **Rust** (`cargo`), **Python development headers** (`python3-dev` or `python3-devel`), and GCC (`build-essential` or `Development Tools`). For the best experience, we recommend using `pip install rustbam`, but if necessary, you can force a source installation with `pip install --no-binary rustbam rustbam`.
+
 ## 🛠️ Usage
 
 ### **Python API**

diff --git a/pyproject.toml b/pyproject.toml
@@ -17,7 +17,7 @@ classifiers = [
     "Topic :: Scientific/Engineering :: Bio-Informatics",
 ]
 requires-python = ">=3.8"
-keywords = ["bam", "bioinformatics", "genomics", "rust", "parallel"]
+keywords = ["bam", "bioinformatics", "genomics", "rust"]
 
 [project.scripts]
 rustbam = "rustbam.cli:get_depths_cli"