Animate, fast and easy
Project description
streamjoy
Animate, fast and easy
Documentation: https://ahuang11.github.io/streamjoy/
Source Code: https://github.com/ahuang11/streamjoy
Development
Setup environment
We use Hatch to manage the development environment and production build. Ensure it's installed on your system.
Run unit tests
You can run all the tests with:
hatch run test
Format the code
Execute the following command to apply linting and check typing:
hatch run lint
Publish a new version
You can bump the version, create a commit and associated tag with one command:
hatch version patch
hatch version minor
hatch version major
Your default Git text editor will open so you can add information about the release.
When you push the tag on GitHub, the workflow will automatically publish it on PyPi and a GitHub release will be created as draft.
Serve the documentation
You can serve the Mkdocs documentation with:
hatch run docs-serve
It'll automatically watch for changes in your code.
License
This project is licensed under the terms of the MIT license.
streamjoy
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
Built Distribution
Hashes for streamjoy-0.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ab46e8c4b85cd6c1bb7f45c68efc34bc62ba8928b94790720accafccffc1cb2 |
|
MD5 | 1f9e9ea9ca6b3c4ad84afc5f922f832e |
|
BLAKE2b-256 | 2ffd97bdce5693d9591b978eee98cf0b5fb98e4d7fdab92e6a977d1e029e5d53 |