Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luca-penasa/spice-segmenter
https://github.com/luca-penasa/spice-segmenter
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/luca-penasa/spice-segmenter
- Owner: luca-penasa
- License: mit
- Created: 2024-11-08T12:39:18.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-08T12:47:56.000Z (3 months ago)
- Last Synced: 2024-12-19T06:52:52.018Z (about 1 month ago)
- Language: Jupyter Notebook
- Size: 1.43 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Spice Segmenter
[](https://pypi.python.org/pypi/spice-segmenter/)
[](https://pypi.python.org/pypi/spice-segmenter/)
[](https://pypi.python.org/pypi/spice-segmenter/)
[](https://github.com/woltapp/wolt-python-package-cookiecutter)
---
**Documentation**: [https://luca-penasa.github.io/spice-segmenter](https://luca-penasa.github.io/spice-segmenter)
**Source Code**: [https://github.com/luca-penasa/spice-segmenter](https://github.com/luca-penasa/spice-segmenter)
**PyPI**: [https://pypi.org/project/spice-segmenter/](https://pypi.org/project/spice-segmenter/)
---
## Installation
```sh
pip install spice-segmenter
```
## Development
* Clone this repository
* Requirements:
* [Poetry](https://python-poetry.org/)
* Python 3.10+
* Create a virtual environment and install the dependencies
```sh
poetry install
```
* Activate the virtual environment
```sh
poetry shell
```
### Testing
```sh
pytest
```
### Documentation
The documentation is automatically generated from the content of the [docs directory](https://github.com/luca-penasa/spice-segmenter/tree/master/docs) and from the docstrings
of the public signatures of the source code. The documentation is updated and published as a [Github Pages page](https://pages.github.com/) automatically as part each release.
### Releasing
#### Manual release
Releases are done with the command, e.g. incrementing patch:
```bash
poetry run just bump patch
# also push, of course:
git push origin main --tags
```
this will update the changelog, commit it, and make a corresponding tag.
as the CI is not yet configured for publish on pypi it can be done by hand:
```bash
poetry publish --build
```
#### Automatic release - to be fixed
Trigger the [Draft release workflow](https://github.com/luca-penasa/spice-segmenter/actions/workflows/draft_release.yml)
(press _Run workflow_). This will update the changelog & version and create a GitHub release which is in _Draft_ state.
Find the draft release from the
[GitHub releases](https://github.com/luca-penasa/spice-segmenter/releases) and publish it. When
a release is published, it'll trigger [release](https://github.com/luca-penasa/spice-segmenter/blob/master/.github/workflows/release.yml) workflow which creates PyPI
release and deploys updated documentation.
### Updating with copier
To update the skeleton of the project using copier:
```sh
pipx run copier update --defaults
```
### Pre-commit
Pre-commit hooks run all the auto-formatting (`ruff format`), linters (e.g. `ruff` and `mypy`), and other quality
checks to make sure the changeset is in good shape before a commit/push happens.
You can install the hooks with (runs for each commit):
```sh
pre-commit install
```
Or if you want them to run only for each push:
```sh
pre-commit install -t pre-push
```
Or if you want e.g. want to run all checks manually for all files:
```sh
pre-commit run --all-files
```
---
This project was generated using [a fork](https://github.com/luca-penasa/wolt-python-package-cookiecutter) of the [wolt-python-package-cookiecutter](https://github.com/woltapp/wolt-python-package-cookiecutter) template.