This release is a pre-release and may not be stable for production use.
Bripy
Bripy is a python library for extracting reads from a bam by read name. It uses the bri library from Jared Simpson.
© 2019 Oxford Nanopore Technologies Ltd.
Installation
bripy can be installed using pip:
pip install bripy
For python3.5 and python3.6 under linux this will download precompiled binaries, in other environments a source distribution will be downloaded and compiled. Compilation from source requires the same libraries as htslib:
'm', 'z', 'lzma', 'bz2', 'pthread', 'curl', 'crypto'
since htslib is built from source as part of the process.
Usage
The library contains a single class interface and two example programs. To index a bam file for later retrieval of reads run:
bripy index <bamfile>
This program is analogous to the bri index <bamfile. The second program
will retrieve reads from a bam by name:
bripy get <bamfile> <read name>
Again this program is analogous to running bri get <bamfile> <read name>.
The bripy API is simple, the following will return a string containing
sam formatted alignments:
bri = BamReadIndex(bam_file)
sam_data = bri.get_alignments(read_name)
This API is likely to change in future to provide a more useful data structure
akin to a pysam.AlignedSegment.
License
Licence and Copyright
© 2019 Oxford Nanopore Technologies Ltd.
bripy is distributed under the terms of the Mozilla Public License 2.0.
Research Release
Research releases are provided as technology demonstrators to provide early access to features or stimulate Community development of tools. Support for this software will be minimal and is only provided directly by the developers. Feature requests, improvements, and discussions are welcome and can be implemented by forking and pull requests. However much as we would like to rectify every issue and piece of feedback users may have, the developers may have limited resource for support of this software. Research releases may be unstable and subject to rapid iteration by Oxford Nanopore Technologies.
Metadata
Release files for bripy 0.0.1a2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| bripy-0.0.1a2.tar.gz | 5.6 MB | Without provenance | Details for bripy-0.0.1a2.tar.gz |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| bripy-0.0.1a2-cp36-cp36m-manylinux1_x86_64.whl | CPython 3.6 | CPython 3.6 pymalloc | Linux glibc 2.5+ x86-64 | Details for bripy-0.0.1a2-cp36-cp36m-manylinux1_x86_64.whl |
| bripy-0.0.1a2-cp35-cp35m-manylinux1_x86_64.whl | CPython 3.5 | CPython 3.5 pymalloc | Linux glibc 2.5+ x86-64 | Details for bripy-0.0.1a2-cp35-cp35m-manylinux1_x86_64.whl |
Total release size: 9.3 MB
Release files / bripy-0.0.1a2.tar.gz
| Download URL | bripy-0.0.1a2.tar.gz |
|---|---|
| Size | 5.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e842a97e044be2bac9537ef0dddfe565d811f190dff0061f31a1a49bcaa3e8c4
|
|
BLAKE2b-256 checksum How to use checksums |
fb7ef175bcb6eb8c70932cecda39db045ecb1a1038ef988d5c152dc613a9567d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.6.9
|
Release files / bripy-0.0.1a2-cp36-cp36m-manylinux1_x86_64.whl
| Download URL | bripy-0.0.1a2-cp36-cp36m-manylinux1_x86_64.whl |
|---|---|
| Size | 1.8 MB |
| Tags | CPython 3.6 CPython 3.6 pymalloc Linux glibc 2.5+ x86-64 |
|
SHA-256 checksum How to use checksums |
de9e92063dc300d5181f3f8fa6ae4c5e8a7d51a301a23beb5d5cbd6c69b1ed47
|
|
BLAKE2b-256 checksum How to use checksums |
673421a990efed342f33edafa61949bbfc6b1c4436f6b6b8160778b709bb58a4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.6.9
|
Release files / bripy-0.0.1a2-cp35-cp35m-manylinux1_x86_64.whl
| Download URL | bripy-0.0.1a2-cp35-cp35m-manylinux1_x86_64.whl |
|---|---|
| Size | 1.8 MB |
| Tags | CPython 3.5 CPython 3.5 pymalloc Linux glibc 2.5+ x86-64 |
|
SHA-256 checksum How to use checksums |
5911ccfa3216571759c60477473366f4491234c90a963117887bfa3dc42571b2
|
|
BLAKE2b-256 checksum How to use checksums |
eec0704d2b850d0f0b40e24a4b155cbd34d316964338c9f209352a010e5b5d5a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.6.9
|
Security for bripy 0.0.1a2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.