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.0.0.tar.gz (316.8 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.0.0-py3-none-any.whl (421.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rnajena_sugar-1.0.0.tar.gz
  • Upload date:
  • Size: 316.8 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.0.0.tar.gz
Algorithm Hash digest
SHA256 fdba50640403a050dad6305f6d54b59d742612bfa2de65b19df193d03a7acbb3
MD5 ea7e006e5839d9281f338876509981aa
BLAKE2b-256 46e4b6e4167a4886f97b8c22a7e6c429d6960e965c08b8eda1e211b9387182c8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rnajena_sugar-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 421.2 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.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2d51f80f059c489dc4960d2b889f8f8ba759ea48a2366ae291c77ca4c91dfa09
MD5 ee9458c2b7e4f44d3a7862607d00de21
BLAKE2b-256 2b47d9979294737ef0edcc6dcac166430ea7a0a361b4b4f0665c7ea5cf5a217a

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