Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ jobs:
python -m pip install --upgrade pip
pip install -e .[dev]

- name: ruff lint
run: ruff check examples src tests
# - name: ruff lint
# run: ruff check examples src tests

- name: ruff format check
run: ruff format --check examples src tests
# - name: ruff format check
# run: ruff format --check examples src tests

- name: run tests
run: pytest -q
# - name: run tests
# run: pytest -q
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,6 @@ __pycache__/
.ruff_cache/
.vscode/
dist/
scratch/
scratch/
*cache*/
*pfam*/
24 changes: 0 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,38 +13,14 @@

Parser for antiSMASH output GenBank files.

See the [examples folder](https://github.com/moltools/biocracker/tree/main/examples) for usage examples.

## Installation

Some BioCracker depdendencies rely on various command line tools to operate. These tools might not be available on all platforms. The `pyproject.toml` file specifies the core parser that is platform independent, but some functionality might be limited without the command line tools. BioCracker is designed to fail gracefully when some of these third party dependencies are not available.

We recommend installing BioCracker in a virtual conda environment, based on the provided `environment.yml` file to make sure all modules are available:

```bash
conda env create -f environment.yml
```

### Installing PARAS

PARAS is used by BioCracker to predict substrate specificities of NRPS adenylation domains.

PARAS has no PyPI package ans must be installed from source manually:

```bash
pip install "paras @ git+https://github.com/bthedragonmaster/parasect.git@v2.0.0"
```

### Installing HMMER2 on macOS Arm64

Use Rosetta to install the x86_64 version of HMMER2:

```bash
conda activate biocracker
conda config --env --set subdir osx-64
conda install hmmer2
```

## Development

To set up a development environment, use the provided `environment.dev.yml` file:
Expand Down
9 changes: 0 additions & 9 deletions environment.dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,8 @@ channels:
- conda-forge
- bioconda
dependencies:
# Python runtime
- python=3.10

# Bio tools (from bioconda)
- hmmer # HMMER v3 (hmmsearch, hmmscan, hmmpress, etc.)
- hmmer2 # HMMER v2 (e.g., hmmpfam, hmmsearch from v2 toolset)
- muscle=3.8.1551 # MUSCLE aligner

# Extra PyPI deps
- pip
- pip:
- -e .
- "paras @ git+https://github.com/bthedragonmaster/parasect.git@v2.0.0"
- hatch
11 changes: 1 addition & 10 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,7 @@ channels:
- conda-forge
- bioconda
dependencies:
# Python runtime
- python=3.10

# Bio tools (from bioconda)
- hmmer # HMMER v3 (hmmsearch, hmmscan, hmmpress, etc.)
- hmmer2 # HMMER v2 (e.g., hmmpfam, hmmsearch from v2 toolset)
- muscle=3.8.1551 # MUSCLE aligner

# Extra PyPI deps
- pip
- pip:
- biocracker
- "paras @ git+https://github.com/bthedragonmaster/parasect.git@v2.0.0"
- biocracker
103 changes: 0 additions & 103 deletions examples/list_domains_antismash_gbk.py

This file was deleted.

89 changes: 0 additions & 89 deletions examples/readout_antismash_gbk.py

This file was deleted.

13 changes: 9 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[project]
name = "biocracker"
version = "1.1.1"
version = "2.0.0"
description = "BioCracker is a parser for antiSMASH output GenBank files"
readme = "README.md"
requires-python = ">=3.10"
requires-python = ">=3.10,<3.12"
license = "MIT"
license-files = [
"LICENSE",
Expand All @@ -14,9 +14,12 @@ authors = [
keywords = ["parser", "antismash"]

dependencies = [
"paras @ git+https://github.com/bthedragonmaster/parasect.git@v2.0.0",
"biopython",
"joblib",
"tqdm"
"tqdm",
"pyhmmer",
"ijson"
]

classifiers = [
Expand All @@ -27,7 +30,6 @@ classifiers = [
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Topic :: Scientific/Engineering :: Bio-Informatics"
]

Expand All @@ -53,6 +55,9 @@ allow-direct-references = true
[tool.hatch.build.targets.wheel]
packages = ["src/biocracker"]
sources = ["src"]
include = [
"src/retromol/data/AMP-binding_converted.hmm"
]

# -------------------------
# Hatch env + scripts
Expand Down
Loading