Metadata-Version: 2.1
Name: labw_utils
Version: 1.0.4
Summary: Utilities Python functions & classes used in LabW
Author-email: YU Zhejian <Zhejian.23@intl.zju.edu.cn>, YUAN Ruihong <Ruihong.19@intl.zju.edu.cn>, SU Yaqi <yaqisu@berkeley.edu>
Project-URL: Source, https://github.com/WanluLiuLab/labw_utils
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: License.md
License-File: Copying.md
Provides-Extra: all
Requires-Dist: fastparquet >=2023.2.0 ; extra == 'all'
Requires-Dist: h5py >=3.9.0 ; extra == 'all'
Requires-Dist: joblib >=1.2 ; extra == 'all'
Requires-Dist: numpy >=1.24 ; extra == 'all'
Requires-Dist: pandas[performance] >=1.4 ; extra == 'all'
Requires-Dist: pyarrow >=9.0.0 ; extra == 'all'
Requires-Dist: pysam >=0.20 ; extra == 'all'
Requires-Dist: pytables >=3.7.0 ; extra == 'all'
Requires-Dist: tomli-w >=1.0 ; extra == 'all'
Requires-Dist: torch ~=2.0.0 ; extra == 'all'
Provides-Extra: appenders
Requires-Dist: pyarrow >=9.0.0 ; extra == 'appenders'
Requires-Dist: fastparquet >=2023.2.0 ; extra == 'appenders'
Requires-Dist: pytables >=3.7.0 ; extra == 'appenders'
Provides-Extra: bioutils
Requires-Dist: pysam >=0.20 ; extra == 'bioutils'
Provides-Extra: defaults
Requires-Dist: tomli-w >=1.0 ; extra == 'defaults'
Requires-Dist: numpy >=1.24 ; extra == 'defaults'
Requires-Dist: pandas[performance] >=1.4 ; extra == 'defaults'
Requires-Dist: joblib >=1.2 ; extra == 'defaults'
Provides-Extra: mlutils
Requires-Dist: torch ~=2.0.0 ; extra == 'mlutils'
Provides-Extra: transposons
Requires-Dist: h5py >=3.9.0 ; extra == 'transposons'

# `labw_utils` -- Utility Python functions & classes used in LabW

**Markdown compatibility guide** This file is written in [Myst-flavored Markdown](https://myst-parser.readthedocs.io/), and may show errors on the default landing page of PYPI or Git Hosting. You can correctly preview it on generated Sphinx documentation or [Visual Studio Code](https://code.visualstudio.com) with [ExecutableBookProject.myst-highlight](https://marketplace.visualstudio.com/items?itemName=ExecutableBookProject.myst-highlight) plugin.

---

**Not finished -- Do not use.**

Badages:
[![Python version](https://img.shields.io/badge/python-3.8-blue)](https://www.python.org/downloads/)
[![PyPI - Version](https://img.shields.io/pypi/v/labw_utils)](https://pypi.org/project/labw_utils/)
[![GitHub Contributors](https://img.shields.io/github/contributors/WanluLiuLab/labw_utils)](https://github.com/WanluLiuLab/labw_utils)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![License](https://img.shields.io/badge/licence-MIT-blue)](https://mit-license.org/)

URLs: [PYPI](https://pypi.org/project/yasim/), [GitHub](https://github.com/WanluLiuLab/yasim).

`labw_utils` contains a series of [Python](http://www.python.org/) functions and classes for biological and general purpose programming in [LabW](https://labw.org/).

The code base is designed with the following principles:

1. Pure-Python implemented.
2. Minimal dependency.

## Installation

### Using pre-built Library from PYPI

You need Python interpreter (CPython implementation) >= 3.8 (recommended 3.9) and latest [`pip`](https://pip.pypa.io/) to install this software from [PYPI](https://pypi.org). Command:

```shell
pip install labw_utils[defaults]
```

You are recommended to use this application inside a virtual environment like [`venv`](https://docs.python.org/3/library/venv.html), [`virtualenv`](https://virtualenv.pypa.io), [`pipenv`](https://pipenv.pypa.io), [`conda`](https://conda.io) or [`poetry`](https://python-poetry.org).

### Build from Source

You need Python interpreter (CPython implementation) >= 3.8 (recommended 3.9), latest PYPA [`build`](https://pypa-build.readthedocs.io) and latest [`setuptools`](https://setuptools.pypa.io/) to build this software. You are recommended to build the software in a virtual environment provided by [`virtualenv`](https://virtualenv.pypa.io), etc.

Build the software using:

```shell
rm -fr dist # Remove build of previous versions
python3 -m build
pip install dist/labw_utils-*.whl
```
