Skip to main content

This package is being developed to help generate beautiful reports.

Project description

shirotsubaki

This package is being developed to help generate beautiful reports.
Documentation

Installation (for Users)

From PyPI

You can install the release version from PyPI.

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.

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shirotsubaki-0.0.1a3.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shirotsubaki-0.0.1a3-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file shirotsubaki-0.0.1a3.tar.gz.

File metadata

  • Download URL: shirotsubaki-0.0.1a3.tar.gz
  • Upload date:
  • Size: 11.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.4

File hashes

Hashes for shirotsubaki-0.0.1a3.tar.gz
Algorithm Hash digest
SHA256 9caf3e4489ffc037b97f1df96e5d90fa3fff72987c4b8598fc3857d56a74b181
MD5 1abddba8481432a062ac09feffe02b15
BLAKE2b-256 5d40c5e3f1c413554ca825e4f1a59ea5e080fcb2bbf269278584bba7b8e48c0c

See more details on using hashes here.

File details

Details for the file shirotsubaki-0.0.1a3-py3-none-any.whl.

File metadata

  • Download URL: shirotsubaki-0.0.1a3-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.4

File hashes

Hashes for shirotsubaki-0.0.1a3-py3-none-any.whl
Algorithm Hash digest
SHA256 55d8c17458be2825b25aa2cd24a470e7b3fb0950e1562d3a8668b7474cdbde5c
MD5 611bbd17b1775fae44895f83ec246e22
BLAKE2b-256 8f3fbbe36655b29fa38bd01a159aee05b928dac68a71928b09d58ef44d30f858

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page