Skip to main content

A Python framework for bioinformatics

Project description

A Python framework for bioinformatics

The sugar project aims to provide a lightweight framework to facilitate rapid application development for bioinformatics.

It thus provides classes and functions for working with DNA and RNA sequences, as well as related annotations, and it provides parsers and writers for various file formats using a plugin interface.

Installation

Sugar requires a Python version >=3.11. Use pip to install the package, e.g.

pip install rnajena-sugar

Other installation options are described in the documentation.

Run tests with the sugar test command. Note that tests that require an Internet connection are skipped by default, this behavior can be turned off with the --web option. Also, depending on the installation and platform, some tests may be skipped or have an expected failure, to see details about the reasons please use the --verbose flag.

Getting started

Read about how to get started in the tutorial section of the documentation.

from sugar import read
seqs = read()  # load example GenBank file
print(seqs)
print(seqs[1].fts)  # show features attached to second sequence
seqs.plot_ftsviewer(show=True)  # plot attached features
aas = seqs['cds'].translate()
print(aas)
aas.write('translated_cds.fasta')

Documentation and Changelog

Documentation can be found at Read the Docs. The detailed changelog is available here.

Contributions

Contributions are welcome! -- e.g. report or fix bugs, discuss or add features, improve the documentation. See the CONTRIBUTING.md file for details.

Citation

If you found this package useful, please consider citing it.

Eulenfeld T (2025), Sugar: A Python framework for bioinformatics, Journal of Open Source Software, 10(111), 8122, doi:10.21105/joss.08122

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

rnajena_sugar-1.1.0.tar.gz (322.7 kB view details)

Uploaded Source

Built Distribution

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

rnajena_sugar-1.1.0-py3-none-any.whl (426.8 kB view details)

Uploaded Python 3

File details

Details for the file rnajena_sugar-1.1.0.tar.gz.

File metadata

  • Download URL: rnajena_sugar-1.1.0.tar.gz
  • Upload date:
  • Size: 322.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.0

File hashes

Hashes for rnajena_sugar-1.1.0.tar.gz
Algorithm Hash digest
SHA256 1ccdb0e1009df6f9467353a94f06a2bb8ad7dffc9986380cb197e8ef4be69db6
MD5 c4c784bb0881ae3da67bbabca69a7803
BLAKE2b-256 b0b14b5bbee734da4a1ff93d20d7df0f2a68d393bd03860a0a09b7c5d5de9c40

See more details on using hashes here.

File details

Details for the file rnajena_sugar-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: rnajena_sugar-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 426.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.0

File hashes

Hashes for rnajena_sugar-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3888b4f1572d24731f992564fae8df2bcd03d294f0ead88250f709a5022f29cf
MD5 3965e6271868c658a9cca0317945ee8c
BLAKE2b-256 0401cdb8603472c53c1c355ba6cb4f75d94c28f2ae642acbf1f4e2c8fc46ceb3

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