Skip to main content

A comprehensive package of biological constants, serving as a foundational resource for biology and bioinformatics, complemented by functions to streamline related tasks.

Project description

Biobase

Static Badge Python Version from PEP 621 TOML PyPI version License: MIT GitHub branch status

A Python package providing standardized biological constants and scoring matrices for bioinformatics pipelines. Biobase aims to eliminate the need to repeatedly recreate common biological data structures and scoring systems in your code.

Table of Contents

Quick Start

Access amino acid properties

from biobase.constants import ONE_LETTER_CODES, MONO_MASS
print(ONE_LETTER_CODES)  # 'ACDEFGHIKLMNPQRSTVWY'
print(MONO_MASS['A'])    # 71.037113805
`FastaRecord``

Use scoring matrices

from biobase.matrix import Blosum
blosum62 = Blosum(62)
print(blosum62['A']['A'])  # 4
print(blosum62['W']['C'])  # -2

Analyze DNA sequences

from biobase.analysis import Dna
sequence = "ATCGTAGC"
print(Dna.transcribe(sequence))         # 'AUCGUAGC'
print(Dna.complement_dna(sequence))     # 'GCTACGAT'
print(Dna.calculate_gc_content(sequence))  # 50.0

Find protein motifs

from biobase.analysis import find_motifs
sequence = "ACDEFGHIKLMNPQRSTVWY"
print(find_motifs(sequence, "DEF"))  # [3]

Parse FASTA

from biobase.parser import fasta_parser
records = fasta_parser(fasta)
for r in records:
    print(r.id) # CAA39742.1
    print(r.seq) # MTNIRKSHPLMKII...

Requirements

  • Python 3.10+
  • pip (for installation)

Installation

Regular Installation

pip install biobase

Development Installation

Clone the repository and install in editable mode:

git clone https://github.com/lignum-vitae/biobase.git
cd biobase
pip install -e .

Running Files

To ensure relative imports work correctly, always run files using the module path from the project root:

Run a specific file

python -m src.biobase.matrix

Data Files

  • src/biobase/matrices/: Scoring matrix data stored in JSON file format

Project Goals

Biobase aims to provide Python-friendly versions of common biological constants and tools for bioinformatics pipelines. Key objectives:

  1. Standardize biological data structures
  2. Provide efficient implementations of common scoring systems
  3. Ensure type safety and validation
  4. Maintain comprehensive documentation
  5. Support modern Python practices

Contributing

We welcome contributions! Please read our:

Project Status

Current Version: 0.4.1-alpha

Core Features

  • ✅ BLOSUM and PAM matrix implementations
  • ✅ Basic amino acid constants and conversions
  • ✅ DNA/RNA sequence analysis tools
  • ✅ Protein motif searching
  • ✅ Core biological constants
  • ✅ Additional scoring matrices
  • ✅ Extended amino acid properties

Analysis Tools

  • ✅ GC content calculation
  • ✅ DNA/RNA transcription
  • ✅ DNA complementation
  • ✅ Motif finding
  • 🚧 File format parsers (FASTA, GenBank, etc.)
  • 📋 Statistical analysis tools

Documentation

  • ✅ Basic README
  • ✅ Code of Conduct
  • ✅ Contributing Guidelines
  • ✅ Usage Examples

Development

  • ✅ PyPI package deployment
  • 🚧 CI/CD Pipeline
  • 🚧 Code Coverage
  • 📋 Automated Releases

Legend

  • ✅ Complete
  • 🚧 In Progress
  • 📋 Planned

Stability

This project is in the alpha stage. APIs may change without warning until version 1.0.0.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

biobase-0.5.1.tar.gz (42.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

biobase-0.5.1-py3-none-any.whl (68.0 kB view details)

Uploaded Python 3

File details

Details for the file biobase-0.5.1.tar.gz.

File metadata

  • Download URL: biobase-0.5.1.tar.gz
  • Upload date:
  • Size: 42.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for biobase-0.5.1.tar.gz
Algorithm Hash digest
SHA256 1db69779e66eed3d1ec56787cc1fe5e972ffced66c3a00ca7f579f3de48fec5b
MD5 6dfa17acaf421e54a7a4108c0210963c
BLAKE2b-256 9baa65902f0f554520ee465e81f2e8743c47b053173f726e1d5fba74b27fbec3

See more details on using hashes here.

File details

Details for the file biobase-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: biobase-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 68.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for biobase-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b8888b3f066717185aab7a5f103a15a31d5a3ac4e12f599ce3a0421ab0c37172
MD5 c5be94067d21c9f14652c81429d13991
BLAKE2b-256 e69e048eef21408d96c0eeac01619a7f1b709e43dfbdfcc9ee53f944c05860b0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page