Metadata-Version: 2.1
Name: RiboSeq-DP-Tools
Version: 0.1.10
Summary: A python command-line utility for working with RiboSeq.Orgs Data Portal
Home-page: https://github.com/riboseqorg/RDP-Tools
Author: Jack Tierney
Author-email: jackcurragh@gmail.com
License: MIT
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: alabaster==0.7.13
Requires-Dist: Babel==2.13.1
Requires-Dist: biopython==1.81
Requires-Dist: certifi==2023.7.22
Requires-Dist: cffi==1.16.0
Requires-Dist: charset-normalizer==3.3.2
Requires-Dist: click==8.1.7
Requires-Dist: contourpy==1.2.0
Requires-Dist: cryptography==41.0.5
Requires-Dist: cycler==0.12.1
Requires-Dist: docutils==0.18.1
Requires-Dist: fonttools==4.44.0
Requires-Dist: idna==3.4
Requires-Dist: imagesize==1.4.1
Requires-Dist: importlib-metadata==6.8.0
Requires-Dist: iniconfig==2.0.0
Requires-Dist: jaraco.classes==3.3.0
Requires-Dist: jeepney==0.8.0
Requires-Dist: Jinja2==3.1.2
Requires-Dist: keyring==24.3.0
Requires-Dist: kiwisolver==1.4.5
Requires-Dist: markdown-it-py==3.0.0
Requires-Dist: MarkupSafe==2.1.3
Requires-Dist: matplotlib==3.8.1
Requires-Dist: mdurl==0.1.2
Requires-Dist: memory-profiler==0.61.0
Requires-Dist: more-itertools==10.1.0
Requires-Dist: nh3==0.2.14
Requires-Dist: numpy==1.26.1
Requires-Dist: packaging==23.2
Requires-Dist: Pillow==10.1.0
Requires-Dist: pkginfo==1.9.6
Requires-Dist: pluggy==1.3.0
Requires-Dist: psutil==5.9.6
Requires-Dist: pycparser==2.21
Requires-Dist: Pygments==2.16.1
Requires-Dist: pyparsing==3.1.1
Requires-Dist: pysam==0.22.0
Requires-Dist: pytest==7.4.3
Requires-Dist: python-dateutil==2.8.2
Requires-Dist: readme-renderer==42.0
Requires-Dist: requests==2.31.0
Requires-Dist: requests-toolbelt==1.0.0
Requires-Dist: rfc3986==2.0.0
Requires-Dist: rich==13.7.0
Requires-Dist: SecretStorage==3.3.3
Requires-Dist: six==1.16.0
Requires-Dist: snowballstemmer==2.2.0
Requires-Dist: Sphinx==7.2.6
Requires-Dist: sphinx-rtd-theme==1.3.0
Requires-Dist: sphinxcontrib-applehelp==1.0.7
Requires-Dist: sphinxcontrib-devhelp==1.0.5
Requires-Dist: sphinxcontrib-htmlhelp==2.0.4
Requires-Dist: sphinxcontrib-jquery==4.1
Requires-Dist: sphinxcontrib-jsmath==1.0.1
Requires-Dist: sphinxcontrib-qthelp==1.0.6
Requires-Dist: sphinxcontrib-serializinghtml==1.1.9
Requires-Dist: twine==4.0.2
Requires-Dist: urllib3==2.0.7
Requires-Dist: zipp==3.17.0

# RDP-Tools

[![PyPI Version](https://img.shields.io/pypi/v/RiboSeq-DP-Tools.svg)](https://pypi.python.org/pypi/RiboSeq-DP-Tools)
[![Documentation Status](https://readthedocs.org/projects/RiboSeq-DP-Tools/badge/?version=latest)](https://RiboSeq-DP-Tools.readthedocs.io/en/latest/?version=latest)

A Python command-line utility for programmatically interacting with RiboSeq.Orgs Data Portal.

- Free software: MIT license
- Documentation: [https://RDP-Tools.readthedocs.io](https://RDP-Tools.readthedocs.io)

## Installation

Install RDP-Tools by running:

```bash
pip install RiboSeq-DP-Tools
```
or:
```bash
docker pull quay.io/jackcurragh/rdp-tools
```


## Usage

RDP-Tools is intended to be used as a command line tool.

To collapse a FASTQ file, run:

```bash
RDP-Tools collapse <input_FASTQ>
```

To inflate a FASTA file, run:

```bash
RDP-Tools inflate <input_FASTA>
```

To inflate a FASTA to a FASTQ file, run:
   
```bash
RDP-Tools inflate <input_FASTA> -o <output_file>.fastq/fq
```

To inflate a BAM file, run:
      
```bash
RDP-Tools inflate <input_BAM>
```

For more information on how to use RDP-Tools, see the documentation_ or use :code:`--help`

documentation: https://rdp-tools.readthedocs.io/en/latest/?version=latest


