Metadata-Version: 2.4
Name: shirotsubaki
Version: 0.0.1a4
Summary: This package is being developed to help generate beautiful reports.
Project-URL: GitHub, https://github.com/CookieBox26/shirotsubaki
Project-URL: Documentation, https://shirotsubaki.readthedocs.io/en/latest/
Author-email: CookieBox26 <cookie-box@cookie-box.info>
License-Expression: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: jinja2
Provides-Extra: docs
Requires-Dist: mkdocs; extra == 'docs'
Requires-Dist: mkdocs-material; extra == 'docs'
Requires-Dist: mkdocstrings-python; extra == 'docs'
Provides-Extra: test
Requires-Dist: matplotlib; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Description-Content-Type: text/markdown

# shirotsubaki

This package is being developed to help generate beautiful reports.  
[Documentation](https://shirotsubaki.readthedocs.io/en/latest/)

### Installation (for Users)

#### From PyPI

You can install the release version from [PyPI](https://pypi.org/project/shirotsubaki/).
```
pip install shirotsubaki
```

#### From Local Source Code

If you want to use the latest version that has not been released, clone this repository and install from the local directory.

```
git clone git@github.com:CookieBox26/shirotsubaki.git
cd shirotsubaki
pip install .
```

### Development Guide (for Developers)

Please run the following commands.

```
git clone git@github.com:CookieBox26/shirotsubaki.git
cd shirotsubaki
# make some changes to the code
pytest  # Please test locally
vi docs/reference.md  # Please update documentation
mkdocs serve  # Please preview documentation locally
```
If you have run the command above, you can view the documentation at http://localhost:8000/.  
If you are not an administrator, please open a pull request at this point.

### Build and upload the distribution archives (for administrator only)

Please run the following commands. More details are [here](https://packaging.python.org/en/latest/tutorials/packaging-projects/).

```
pip install --upgrade build
pip install --upgrade twine
pip install --upgrade pkginfo  # This might be needed

python -m build
python -m twine upload dist/*
```
