Skip to main content

Proksee Batch

Project description

Proksee Batch

PyPI Status Python Version License

Read the documentation at https://proksee-batch.readthedocs.io/ Tests

pre-commit Black

Features

Proksee Batch is a command-line tool for visualizing multiple prokaryotic genomes via the Proksee web application. Instead of manually uploading each genome to Proksee and manually configuring the visualization, Proksee Batch allows you to, with a single command, upload multiple genomes with custom configuration options, add features from additonal files, and obtain links to Proksee projects for further analysis of each genome. Also, Proksee Batch is designed to be included in bioinformatics workflows/pipelines for analyzing hundreds of genomes efficiently and reproducibly.

The main advantage over alternative command-line genome visualization tools is that Proksee Batch provides access to the genome information in the form of an interactive Proksee map that supports zooming to the nucleotide level and that is linked to numerous additional tools for further genome analysis via the graphical interface. The genome maps can also be easily customized within Proksee and exported in a variety of formats.

Installation

You can simply install Proksee Batch via pip from PyPI:

pip install proksee-batch

Or, better yet, use pipx to install Proksee Batch from PyPI in an isolated environment:

pipx install proksee-batch

To install Proksee Batch in a conda environment, use a YAML file like this:

name: proksee-batch
channels:
  - conda-forge
dependencies:
  - python=3.11
  - pip
  - pip:
      - proksee-batch

Usage

Please see the Command-line Reference for details.

Contributing

Contributions are welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Proksee Batch is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

Authors: Lael Barlow and Jason Grant

This project was initially generated using @cjolowicz's Hypermodern Python Cookiecutter template.

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

proksee_batch-0.6.5.tar.gz (7.7 MB view details)

Uploaded Source

Built Distribution

proksee_batch-0.6.5-py3-none-any.whl (8.0 MB view details)

Uploaded Python 3

File details

Details for the file proksee_batch-0.6.5.tar.gz.

File metadata

  • Download URL: proksee_batch-0.6.5.tar.gz
  • Upload date:
  • Size: 7.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for proksee_batch-0.6.5.tar.gz
Algorithm Hash digest
SHA256 8b1fea22162e6dfcc864027d5af3fc87365ed3c9890cebffac152bd7cbbd27c7
MD5 0c727d410aedf47aad09e948b05c586e
BLAKE2b-256 37dc92107225acab4806840e18c46b2a0170b2c7232ae2d389b40b51d92074d6

See more details on using hashes here.

File details

Details for the file proksee_batch-0.6.5-py3-none-any.whl.

File metadata

File hashes

Hashes for proksee_batch-0.6.5-py3-none-any.whl
Algorithm Hash digest
SHA256 85056354010b621fa80c24d55d380c4ee9283121f93994718acbbfd589bc2d45
MD5 f44e87bfff688daf5f91c47c3b22c1d5
BLAKE2b-256 5a9ee46f90a172c75c65fdd3b01f05d0c74f8e30b2511727b782fafc2c9602d8

See more details on using hashes here.

Supported by

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