Metadata-Version: 2.4
Name: magic-qc
Version: 0.1.0
Summary: 自动化质量检测与筛选工具
Project-URL: bugs, https://github.com/wxd123/magic_qc/issues
Project-URL: changelog, https://github.com/wxd123/magic_qc/releases
Project-URL: documentation, https://wxd123.github.io/magic_qc/
Project-URL: homepage, https://github.com/wxd123/magic_qc
Author-email: jackson wang <wxd123@users.noreply.github.com>
Maintainer-email: jackson wang <wxd123@users.noreply.github.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Programming Language :: Python :: 3
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: dlib>=20.0.1
Requires-Dist: imageio>=2.37.3
Requires-Dist: matplotlib>=3.10.8
Requires-Dist: numpy>=2.4.4
Requires-Dist: opencv-python>=4.13.0.92
Requires-Dist: pandas>=3.0.2
Requires-Dist: rich
Requires-Dist: scikit-image>=0.26.0
Requires-Dist: scipy>=1.17.1
Requires-Dist: tifffile>=2026.3.3
Requires-Dist: typer
Description-Content-Type: text/markdown

# Magic-QC

![PyPI version](https://img.shields.io/pypi/v/magic_qc.svg)

自动化质量检测与筛选工具

* [GitHub](https://github.com/wxd123/magic-qc/) | [PyPI](https://pypi.org/project/magic_qc/) | [Documentation](https://wxd123.github.io/magic-qc/)
* Created by [jackson wang](https://www.etd-soft.com) | GitHub [@wxd123](https://github.com/wxd123) | PyPI [@wxd123](https://pypi.org/user/wxd123/)
* MIT License

## Features

* TODO

## Documentation

Documentation is built with [Zensical](https://zensical.org/) and deployed to GitHub Pages.

* **Live site:** https://wxd123.github.io/magic_qc/
* **Preview locally:** `just docs-serve` (serves at http://localhost:8000)
* **Build:** `just docs-build`

API documentation is auto-generated from docstrings using [mkdocstrings](https://mkdocstrings.github.io/).

Docs deploy automatically on push to `main` via GitHub Actions. To enable this, go to your repo's Settings > Pages and set the source to **GitHub Actions**.

## Development

To set up for local development:

```bash
# Clone your fork
git clone git@github.com:your_username/magic_qc.git
cd magic_qc

# Install in editable mode with live updates
uv tool install --editable .
```

This installs the CLI globally but with live updates - any changes you make to the source code are immediately available when you run `magic_qc`.

Run tests:

```bash
uv run pytest
```

Run quality checks (format, lint, type check, test):

```bash
just qa
```

## Author

magic_qc was created in 2026 by jackson wang.

Built with [Cookiecutter](https://github.com/cookiecutter/cookiecutter) and the [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) project template.


