Metadata-Version: 2.4
Name: mgnify-methods
Version: 0.1.0
Summary: Support methods and classes for the Biodiversity studies on Mgnify metagenomes
Author-email: palec87 <palec87@users.noreply.github.com>
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: biopython>=1.81.0
Requires-Dist: ipykernel>=6.0.0
Requires-Dist: jsonapi-client>=0.9.9
Requires-Dist: jupyterlab>=4.0.0
Requires-Dist: marine-omics>=0.1.17
Requires-Dist: matplotlib-venn>=1.1.2
Requires-Dist: matplotlib>=3.8.0
Requires-Dist: numpy>=1.25.0
Requires-Dist: pandas>=2.0.0
Requires-Dist: pydantic>=2.12.0
Requires-Dist: pydeseq2>=0.5.4
Requires-Dist: requests>=2.31.0
Requires-Dist: scikit-learn>=1.4.0
Requires-Dist: scipy>=1.11.0
Requires-Dist: seaborn>=0.13.0
Requires-Dist: setuptools<81.0.0,>=68.0.0
Requires-Dist: tqdm>=4.66.0
Provides-Extra: dev
Requires-Dist: ipykernel>=6.0.0; extra == 'dev'
Requires-Dist: jupyterlab>=4.0.0; extra == 'dev'
Requires-Dist: mypy>=1.8.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: myst-parser>=2.0.0; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints>=1.25.0; extra == 'docs'
Requires-Dist: sphinx-rtd-theme>=2.0.0; extra == 'docs'
Requires-Dist: sphinx>=7.0.0; extra == 'docs'
Description-Content-Type: text/markdown

# mgnify-methods

Support methods and classes for the Biodiversity studies on Mgnify metagenomes

## Installation

### Using uv (recommended)

```bash
uv add mgnify-methods
```

### Using pip

```bash
pip install mgnify-methods
```

### From source

```bash
git clone https://github.com/palec87/mgnify-methods.git
cd mgnify-methods
uv sync
```

## Development

This project uses `uv` for dependency management and has a `Makefile` for common development tasks.

### Setup development environment

```bash
make dev-install
```

### Run tests

```bash
make test
```

### Run linters

```bash
make lint
```

### Format code

```bash
make format
```

### Build documentation

```bash
make docs
```

### Build package

```bash
make build
```

### Available Make targets

Run `make help` to see all available targets.

## Documentation

Documentation is available at [ReadTheDocs](https://mgnify-methods.readthedocs.io/) (once deployed).

## License

See [LICENSE](LICENSE) file for details.

