bbmapy 0.0.45__tar.gz → 0.0.51__tar.gz

bbmapy-0.0.51/.gitignore

@@ -0,0 +1,179 @@
+# vendor
+# bbmapy/vendor/  # Commented out to allow vendor directory in package
+test
+.vscode/**  
+.cursorignore
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+.vscode
+.pypirc
+.pypi
+.pypi-version
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+.vscode/settings.json
+.vscode/settings.json
+.vscode/settings.json
+
+# pixi environments
+.pixi
+*.egg-info

bbmapy-0.0.51/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.4
+Name: bbmapy
+Version: 0.0.51
+Summary: A Python wrapper for BBTools
+Project-URL: Homepage, https://github.com/urineri/bbmapy
+Project-URL: Repository, https://github.com/urineri/bbmapy.git
+Project-URL: BBTools Repository, https://bitbucket.org/berkeleylab/jgi-bbtools/src/master/
+License: see https://bitbucket.org/berkeleylab/jgi-bbtools/src/master/license.txt
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3.9
+Requires-Python: >=3.9
+Requires-Dist: install-jdk
+Requires-Dist: rich
+Description-Content-Type: text/markdown
+
+# bbmapy
+
+A Python wrapper for BBTools.
+Current version of bbmapy is v39.33.
+
+## Installation
+
+```bash
+conda install -c bioconda -c conda-forge bbmapy # not yet available on conda-forge
+```  
+Also available on pip (but does not ensure java is available):
+```bash
+pip install bbmapy
+```
+
+## Usage
+
+bbmapy let's you call bbtools stuff from python. To the shell only one CLI is available:  
+- `bbmapy-test`: Run tests to verify installation
+
+### Example
+
+```python
+from bbmapy import bbmap
+
+# Run bbmap.sh
+bbmap.bbmap(
+    in1="reads1.fastq",
+    in2="reads2.fastq",
+    out="mapped.sam",
+    ref="reference.fasta"
+)
+```
+
+## Dependencies
+
+- Python >= 3.9
+- rich
+- install-jdk (this will be used to install a JRE if needed)
+
+## Usage
+
+After installation, you can use bbmapy in your Python scripts like this:
+
+```python
+from bbmapy import bbduk
+
+# Basic usage
+bbduk(
+    in_file="input.fastq",
+    out="output.fastq",
+    ktrim="r",
+    k="23",
+    mink="11",
+    hdist="1",
+    tbo=True,
+    tpe=True,
+    minlen="45",
+    ref="adapters",
+    ftm="5",
+    maq="6",
+    maxns="1",
+    ordered=True,
+    threads="4",
+    overwrite="t",
+    stats="stats.txt"
+)
+```
+### Using Java flags alongside other arguments
+```python
+bbduk(
+    Xmx="2g",  # Set maximum heap size
+    da=True,   # Enable assertions
+    eoom=True, # Enable out-of-memory termination
+    in_file="input.fastq",
+    out="output.fastq",
+    ktrim="r",
+    k="23"
+)
+```
+
+### To capture output
+You need to set `capture_output=True` in the function call, AND out="stdout.fastq" (or any other file format you like). 
+```python
+stdout, stderr = bbduk(
+    capture_output=True,
+    Xmx="2g",
+    in_file="input.fastq",
+    out="stdout.fastq",
+    # ... other parameters ...
+)
+```
+
+#### Getting java executable
+Can be a pain, see [this PR discussion](https://github.com/conda-forge/staged-recipes/pull/29085).  
+bioconda's recipes that require java will usually bring a really bloated set of stuff. not good. way too much useless bandwidth (I see no reason that getting bbmap would require alsa).  
+But pip and bioconda recipies allow using other pip and conda recipes. Good. A workaround - adding a custom function that recognizes the os + arch and fetches during install or test.  
+Technically - this does not count as preloading a binary/executable. The actual JRE is tiny, and getting it can be done via [`install-jdk`](https://pypi.org/project/install-jdk/).  
+
+tl;dr: after installing from pypi (via pip/uv/pixi)
+```
+bbmapy-ensure-java
+```  
+
+
+#### Notes:
+ * `in` can be a protected word in python and other code, it is replaced by `in_file` in function calls. `in1`, `in2` are still valid.
+ * Java flags (such as `Xmx`, `Xms`, `da`, `ea`, `eoom`) are automatically recognized and handled appropriately. Include them in your function calls just like any other argument.
+ * the `capture_output` argument might be switched (stderr --> out and vice verse). 
+ * Flags (i.e. argument that do not take value in the OG bbmap version) are set with Boolean values. e.g.:
+ ``` 
+ flag : True
+ ```
+ Not to be mistaken for lower case, fouble qouted `"true"` and `"false"` for boolian arguments to be passed to bbtools, e.g.:
+ ```
+ argument : "true"
+ ```
+ 
+### Citation
+BBMerge manuscript: https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0185056
+Please cite this paper if you use bbmap in your work.
+
+
+
+## License
+
+This project is only a wrapper, please see the actual bbtools repository for (license)[https://bitbucket.org/berkeleylab/jgi-bbtools/src/master/license.txt] etc.  
+Neither the developers of bbtools nor of bbmapy take any responsibility for how you use this code. All accountability is on you.
+
+## Acknowledgments
+
+This project only (crudely) wraps BBTools (a.k.a bbmap), which is developed by Brian Bushnell.  
+If you use bbmapy and things don't quite work like you'd like, don't expect the developer of bbmap to help you with this whacky python wrapper.  
+Please see the [BBTools website](https://jgi.doe.gov/data-and-tools/bbtools/) for more information about the underlying tools.  
+
+
+### to build and upload to pypi
+
+```bash
+rm -rf dist build egg-info
+python bbmapy/update.py # fetch latest version of bbtools and update version in pyproject.toml
+rm bbmapy/vendor/bbmap/pytools -rf # remove the pytools folder
+pip install --upgrade build twine
+python -m build
+twine upload dist/*
+
+```

bbmapy-0.0.51/README.md

@@ -0,0 +1,147 @@
+# bbmapy
+
+A Python wrapper for BBTools.
+Current version of bbmapy is v39.33.
+
+## Installation
+
+```bash
+conda install -c bioconda -c conda-forge bbmapy # not yet available on conda-forge
+```  
+Also available on pip (but does not ensure java is available):
+```bash
+pip install bbmapy
+```
+
+## Usage
+
+bbmapy let's you call bbtools stuff from python. To the shell only one CLI is available:  
+- `bbmapy-test`: Run tests to verify installation
+
+### Example
+
+```python
+from bbmapy import bbmap
+
+# Run bbmap.sh
+bbmap.bbmap(
+    in1="reads1.fastq",
+    in2="reads2.fastq",
+    out="mapped.sam",
+    ref="reference.fasta"
+)
+```
+
+## Dependencies
+
+- Python >= 3.9
+- rich
+- install-jdk (this will be used to install a JRE if needed)
+
+## Usage
+
+After installation, you can use bbmapy in your Python scripts like this:
+
+```python
+from bbmapy import bbduk
+
+# Basic usage
+bbduk(
+    in_file="input.fastq",
+    out="output.fastq",
+    ktrim="r",
+    k="23",
+    mink="11",
+    hdist="1",
+    tbo=True,
+    tpe=True,
+    minlen="45",
+    ref="adapters",
+    ftm="5",
+    maq="6",
+    maxns="1",
+    ordered=True,
+    threads="4",
+    overwrite="t",
+    stats="stats.txt"
+)
+```
+### Using Java flags alongside other arguments
+```python
+bbduk(
+    Xmx="2g",  # Set maximum heap size
+    da=True,   # Enable assertions
+    eoom=True, # Enable out-of-memory termination
+    in_file="input.fastq",
+    out="output.fastq",
+    ktrim="r",
+    k="23"
+)
+```
+
+### To capture output
+You need to set `capture_output=True` in the function call, AND out="stdout.fastq" (or any other file format you like). 
+```python
+stdout, stderr = bbduk(
+    capture_output=True,
+    Xmx="2g",
+    in_file="input.fastq",
+    out="stdout.fastq",
+    # ... other parameters ...
+)
+```
+
+#### Getting java executable
+Can be a pain, see [this PR discussion](https://github.com/conda-forge/staged-recipes/pull/29085).  
+bioconda's recipes that require java will usually bring a really bloated set of stuff. not good. way too much useless bandwidth (I see no reason that getting bbmap would require alsa).  
+But pip and bioconda recipies allow using other pip and conda recipes. Good. A workaround - adding a custom function that recognizes the os + arch and fetches during install or test.  
+Technically - this does not count as preloading a binary/executable. The actual JRE is tiny, and getting it can be done via [`install-jdk`](https://pypi.org/project/install-jdk/).  
+
+tl;dr: after installing from pypi (via pip/uv/pixi)
+```
+bbmapy-ensure-java
+```  
+
+
+#### Notes:
+ * `in` can be a protected word in python and other code, it is replaced by `in_file` in function calls. `in1`, `in2` are still valid.
+ * Java flags (such as `Xmx`, `Xms`, `da`, `ea`, `eoom`) are automatically recognized and handled appropriately. Include them in your function calls just like any other argument.
+ * the `capture_output` argument might be switched (stderr --> out and vice verse). 
+ * Flags (i.e. argument that do not take value in the OG bbmap version) are set with Boolean values. e.g.:
+ ``` 
+ flag : True
+ ```
+ Not to be mistaken for lower case, fouble qouted `"true"` and `"false"` for boolian arguments to be passed to bbtools, e.g.:
+ ```
+ argument : "true"
+ ```
+ 
+### Citation
+BBMerge manuscript: https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0185056
+Please cite this paper if you use bbmap in your work.
+
+
+
+## License
+
+This project is only a wrapper, please see the actual bbtools repository for (license)[https://bitbucket.org/berkeleylab/jgi-bbtools/src/master/license.txt] etc.  
+Neither the developers of bbtools nor of bbmapy take any responsibility for how you use this code. All accountability is on you.
+
+## Acknowledgments
+
+This project only (crudely) wraps BBTools (a.k.a bbmap), which is developed by Brian Bushnell.  
+If you use bbmapy and things don't quite work like you'd like, don't expect the developer of bbmap to help you with this whacky python wrapper.  
+Please see the [BBTools website](https://jgi.doe.gov/data-and-tools/bbtools/) for more information about the underlying tools.  
+
+
+### to build and upload to pypi
+
+```bash
+rm -rf dist build egg-info
+python bbmapy/update.py # fetch latest version of bbtools and update version in pyproject.toml
+rm bbmapy/vendor/bbmap/pytools -rf # remove the pytools folder
+pip install --upgrade build twine
+python -m build
+twine upload dist/*
+
+```