Metadata-Version: 2.1
Name: mipscripts
Version: 0.3.2
Summary: Various tools for use with MIPTools pipelines.
Home-page: https://github.com/bailey-lab/mipscripts
Author: Bailey Lab
Author-email: isaac_kim@brown.edu
Project-URL: Bug Tracker, https://github.com/bailey-lab/mipscripts/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# mipscripts

mipscripts is a python package containing various tools for use with MIPTools
pipelines.

## Installation

You may install using pip:

```shell
pip install mipscripts
```

## Usage

mipscripts is setup as one uniform program containing multiple subcommands,
each designed for a different purpose. To use, simply type the name of the
package, followed by the subcommand:

```shell
python3 -m mipscripts subcommand [options]
```

## Developer

When developing mipscripts, we recommend the use of a virtual environment:

```shell
python3 -m venv env
source env/bin/activate
```

The packages used during development are saved in the `requirements.txt` file.
To install, use pip:

```shell
pip install -r requirements.txt
````

If you update packages or add any new ones into the virtual environment, please
make sure to freeze the package versions before committing:

```shell
pip freeze > requirements.txt
```
