girsh 0.1.36

This tool downloads and installs release binaries from GitHub repositories.

girsh - Git Install Released Software Helper

This tool downloads and installs released binaries from GitHub repositories on Linux type systems.

• Github repository: https://github.com/palto42/girsh/
• Documentation https://palto42.github.io/girsh/

Description

This script reads input from a YAML file to define GitHub release pages, binary package patterns, and extraction rules. The script handles downloads, extraction, renaming, and copying to the appropriate binary folder based on user permissions.

The script checks whether the user has root privileges to copy binaries to /usr/local/bin; otherwise, it defaults to ~/.local/bin.

Development

1. Clone the repository

First, clone the project repository, and then run the following commands:

git clone ssh://[e-mail]:palto42/girsh.git

2. Set Up Your Development Environment

Then, install the environment and the pre-commit hooks with

make install

3. Run the pre-commit hooks

Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:

uv run pre-commit run -a

or run

make check`

4. Test the code

Run the Python unit tests with the command:

make test

• For a console coverage report, run coverage report
• For a local HTML coverage report, run coverage html

5. Commit the changes

Lastly, commit the changes made by the two steps above to your repository.

git add .
git commit -m 'Fix formatting issues'
git push origin main

You are now ready to start development on your project! The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

To finalize the set-up for publishing to PyPI, see here. For activating the automatic documentation with MkDocs, see here. To enable the code coverage reports, see here.

Releasing a new version

• Create an API Token on PyPI.
• Add the API Token to your projects secrets with the name PYPI_TOKEN by visiting this page.
• Create a new release on Github.
• Create a new tag in the form *.*.*.

For more details, see here.

3. Use make commands

make command	Description
install	Install the virtual environment and install the pre-commit hooks
check	Run code quality tools.
test	Test the code with pytest
build	Build wheel file
clean-build	Clean build artifacts
publish	Publish a release to PyPI.
build-and-publish	Build and publish.
docs	Build and serve the documentation
docs-test	Test if documentation can be built without warnings or errors

Note: make check validates the files stages with git add. Otherwise it may show only "(no files to check)Skipped" messages.