A set of utilities to maintain Gentoo overlay
Project description
Description
Provides certain tools to be run on the overlay directory. See individual commands help for details.
This is a small collection of tools to help automate some tasks related to Gentoo overlay maintenance.
It can:
- Generate a README like this.
- Look up a package in remotes and tell if a new version is available.
- Look up a package on repology.org and show the newest known versions.
Getting started
Installation
Install the project from PyPI:
$ pip install --user overlay-maintain-tools
Or from nitratesky overlay:
$ eselect repository enable nitratesky && emerge -a1 app-portage/overlay-maintain-tools
Sample usage
The overlay directory is at /srv/overlay
. To generate a README with the badges, create a skeleton template
(like the one in repo) and run:
$ overlay_maintain_tools --overlay-dir /srv/overlay mkreadme --skeleton-file /path/to/readme.template
To generate a report on packages versions in overlay, make sure that metadata.xml
file has remotes set and run:
$ overlay_maintain_tools --overlay-dir /srv/overlay check-remote-versions
To look up versions in repology, create a file with mapping between package atoms and project names in repology and specify it when running the script:
$ cat /srv/overlay/repology_cache
net-news/newsboat newsboat
$ overlay_maintain_tools --overlay-dir /srv/overlay check-repology --repology-cache-location /srv/overlay/repology_cache
Details
Usage:
$ overlay_maintain_tools [OPTIONS] COMMAND [ARGS]...
General Options:
--version
: Show version and exit.--overlay-dir PATH
: Specify location for overlay. [default: .]--worker-count INTEGER RANGE
: Number of workers for creating package cache. [default: 8]--quiet
: Suppresses output. For commands checking versions exit code 100 means newer versions are available. [default: False]--install-completion
: Install completion for the current shell.--show-completion
: Show completion for the current shell, to copy it or customize the installation.--help
: Show this message and exit.
These options can be specified for any COMMAND
except for create-config
which ignores these options.
Commands:
check-remote-versions
: Prints report on the versions of packages.check-repology
: Returns versions known to repology.mkreadme
: Creates a README for an overlay.
Commands
overlay_maintain_tools mkreadme
Creates a README for an overlay. The generated README can utilize data on packages available in the overlay and their versions. For sample template, see the documentation.
Usage:
$ overlay_maintain_tools mkreadme [OPTIONS]
Options:
--skeleton-file PATH
: The file containing README template. Should be inside the template directory.--template-dir DIRECTORY
: Template directory. Can be specified if more complex jinja2 templates will be used.--output PATH
: Where to save the resulting README. If not supplied - print to stdout.--help
: Show this message and exit.
overlay_maintain_tools check-remote-versions
Prints report on the versions of packages. Checks versions available upstream. Pulls the data from remotes specified inside tag in metadata.xml
Usage:
$ overlay_maintain_tools check-remote-versions [OPTIONS]
Options:
--show-updates-only
: Shows only packages that have updates with links to remotes_with_new_versions.--background
: Suppress output of this subcommand completely. Exit code = 100 denotes that there are updates in remotes--color
: Enable/disable color in output--help
: Show this message and exit.
overlay_maintain_tools check-repology
Returns versions known to repology. Reported versions will be newer than ones in overlay.
Usage:
$ overlay_maintain_tools check-repology [OPTIONS]
Options:
--repology-cache-location PATH
: Path to file with the mappings between overlay package and repology project--help
: Show this message and exit.
Contrib directory
There are shell completions for bash and zsh (generated through typer).
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
File details
Details for the file overlay_maintain_tools-1.3.1.tar.gz
.
File metadata
- Download URL: overlay_maintain_tools-1.3.1.tar.gz
- Upload date:
- Size: 24.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0da2983a206d3bb7fdb68fa082b9b3a57785a15755c692669ffe4fa91a2cec5 |
|
MD5 | f5fd14afc54274ef39f461620f302d95 |
|
BLAKE2b-256 | b02321d5f1ba3efd0089934c12baa6fddc9bd4e3958d4d61f79ff012e95facf9 |
File details
Details for the file overlay_maintain_tools-1.3.1-py3-none-any.whl
.
File metadata
- Download URL: overlay_maintain_tools-1.3.1-py3-none-any.whl
- Upload date:
- Size: 27.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 98fd2e3edd2c25329f48d6dda2d74734431c97242d6a1814441d31d953af3b2d |
|
MD5 | 1822f2b1ca56aed5c0243442ab941a50 |
|
BLAKE2b-256 | 694f308c2be76849c16dc641adb7546ffca62101e56853c7c8c5f698bf1885d5 |