Metadata-Version: 2.5
Name: biotapy
Version: 0.0.1
Summary: mia-style microbiome toolkit for Python on AnnData/TreeData
Project-URL: Documentation, https://biotapy.readthedocs.io/
Project-URL: Homepage, https://github.com/pedrocr83/biotapy
Project-URL: Source, https://github.com/pedrocr83/biotapy
Author: Pedro Ribeiro
Maintainer-email: Pedro Ribeiro <pedrocasalribeiro@gmail.com>
License: BSD 3-Clause License
        
        Copyright (c) 2026, Pedro Ribeiro
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.12
Requires-Dist: anndata
Requires-Dist: numpy
Requires-Dist: session-info2
Description-Content-Type: text/markdown

# biotapy

[![Tests][badge-tests]][tests]
[![Documentation][badge-docs]][documentation]

[badge-tests]: https://img.shields.io/github/actions/workflow/status/pedrocr83/biotapy/test.yaml?branch=master
[badge-docs]: https://app.readthedocs.org/projects/biotapy/badge/

mia-style microbiome toolkit for Python on AnnData/TreeData

## Getting started

Please refer to the [documentation][],
in particular, the [API documentation][].

## Installation

You need to have Python 3.12 or newer installed on your system.
If you don't have Python installed, we recommend installing [uv][].

We recommend managing dependencies in project-specific virtual environments to avoid dependency conflicts.
This is most convenient using package managers such as [uv][].
Choose from the options below to install biotapy:

<!--
1. Add the latest release of `biotapy` from [PyPI][] to your `uv` project:

   ```bash
   uv add biotapy
   ```

1. Install the latest release into a [standard virtual environment][venv]:

   ```bash
   (after activating your venv)
   pip install biotapy
   ```

-->

1. Install the latest development version:

   ```bash
   pip install git+https://github.com/pedrocr83/biotapy.git  # (or `uv add`)
   ```

## Release notes

See the [changelog][].

## Contact

For questions and help requests, you can reach out in the [scverse discourse][].
If you found a bug, please use the [issue tracker][].

## Citation

> t.b.a

[uv]: https://github.com/astral-sh/uv
[scverse discourse]: https://discourse.scverse.org/
[issue tracker]: https://github.com/pedrocr83/biotapy/issues
[tests]: https://github.com/pedrocr83/biotapy/actions/workflows/test.yaml
[documentation]: https://biotapy.readthedocs.io
[changelog]: https://biotapy.readthedocs.io/page/changelog.html
[api documentation]: https://biotapy.readthedocs.io/page/api.html
[pypi]: https://pypi.org/project/biotapy
[venv]: https://docs.python.org/3/tutorial/venv.html
