Package: overlay-maintain-tools
DescriptionProvides 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 onrepology.organd show the newest known versions.Getting startedInstallationInstall the project from PyPI:$pipinstall--useroverlay-maintain-toolsOr from nitratesky overlay:$eselectrepositoryenablenitratesky&&emerge-a1app-portage/overlay-maintain-toolsSample usageThe overlay directory is at/srv/overlay. To generate a README with the badges, create a skeleton template
(likethe one in repo) and run:$ overlay_maintain_tools --overlay-dir /srv/overlay mkreadme --skeleton-file /path/to/readme.templateTo generate a report on packages versions in overlay, make sure thatmetadata.xmlfile has remotes set and run:$ overlay_maintain_tools --overlay-dir /srv/overlay check-remote-versionsTo 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_cacheDetailsUsage:$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 anyCOMMANDexcept forcreate-configwhich 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.Commandsoverlay_maintain_tools mkreadmeCreates 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_toolsmkreadme[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-versionsPrints report on the versions of packages. Checks versions available upstream.
Pulls the data from remotes specified inside  tag in metadata.xmlUsage:$overlay_maintain_toolscheck-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-repologyReturns versions known to repology. Reported versions will be newer than ones in overlay.Usage:$overlay_maintain_toolscheck-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 directoryThere are shell completions for bash and zsh (generated throughtyper).