openmamba/distromatic
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README.md: add an initial basic documentation file

Browse Source
This commit is contained in:
Silvan Calarco 2024-08-11 20:56:05 +02:00
parent c5b4c1ace4
commit 32120c4208
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md Normal file
View File

@ -0,0 +1,25 @@
distromatic project for the *openmamba Linux* distribution
==================================================
This project provides tools that have been developed by the maintainers of the *openmamba Linux* distribution in order to maintain, monitor and provide user interfaces for RPM based package repositories.
## `distromatic` tool
`distromatic` is a command line tool which scans repositories with `rpm` and `srpm` packages or `repodata` folders containing metadata files and provides output files as *sqlite* databases, plaintext and html with detailed information on repositories and packages.
The created files are used for distribution maintainance purposes and to provide informative interfaces to end users.
## `distroquery` tool
`distroquery` is a command line tool intended to be used as a `CGI` backend for the web. It provides **API** interfaces intended to be used by *web frontends* and *development instruments* in order to provide dynamic information on distribution repositories and packages.
### `distroquery` API services
The newest distroquery API interface is currently available from this prefix: [https://push.openmamba.org/openmamba/distroquery/api/v1](https://push.openmamba.org/openmamba/distroquery/api/v1).
#### Sample endpoints
* Repositories list: [https://push.openmamba.org/openmamba/distroquery/api/v1/repositories](https://push.openmamba.org/openmamba/distroquery/api/v1/repositories)
* Repository packages: [https://push.openmamba.org/openmamba/distroquery/api/v1/repository/base?page=1&per_page=10](https://push.openmamba.org/openmamba/distroquery/api/v1/repository/base?page=1&per_page=10)
* Source package details: [https://push.openmamba.org/openmamba/distroquery/api/v1/package/base/bash](https://push.openmamba.org/openmamba/distroquery/api/v1/package/base/bash)
* Binary package details: [https://push.openmamba.org/openmamba/distroquery/api/v1/package/base/bash/x86_64](https://push.openmamba.org/openmamba/distroquery/api/v1/package/base/bash/x86_64)
* Binary package files list: [https://push.openmamba.org/openmamba/distroquery/api/v1/package_files/base/bash/x86_64](https://push.openmamba.org/openmamba/distroquery/api/v1/package_files/base/bash/x86_64)
* Providers for file: [https://push.openmamba.org/openmamba/distroquery/api/v1/file_providers/base/%2Fbin%2Fbash/x86_64](https://push.openmamba.org/openmamba/distroquery/api/v1/file_providers/base/%2Fbin%2Fbash/x86_64)
* Providers for requirement: [https://push.openmamba.org/openmamba/distroquery/api/v1/providers/base/glibc/>=/2.40](https://push.openmamba.org/openmamba/distroquery/api/v1/providers/base/glibc/>=/2.40)
* Repository problems: [https://push.openmamba.org/openmamba/distroquery/api/v1/problems/base](https://push.openmamba.org/openmamba/distroquery/api/v1/problems/base)