Commit ef8f293e authored by onny's avatar onny
Browse files

enhanced README.md

parent a5a4194f
arch-upstream v0.1
# Arch-Upstream
test
![header](https://onny.project-insanity.org/files/screenshot-arch-upstream.png)
Script that gathers version information from all AUR and common ArchLinux
repositories. Each package version is getting compared to an upstream version
provided by the Fedora community project [Release-Monitoring.org (Anitya)](https://release-monitoring.org).
Finally, the script generates a html report page with out-of-date software
packages.
## Features
- [x] Scrape version information of all AUR packages
- [x] Scrape version information of all common ArchLinux packages
- [x] Compare package version with upstream version
- [x] Export html report
- [x] Query if package already flagged
## Limitations
* Release-monitoring Anitya database dump gets only updated once per day
## Maintainers
* [Jonas Heinrich](https://git.project-insanity.org/onny)
## Running
### Requirements
* Python modules: python-beautifulsoup4, python-requests, python-progressbar,
python-jinja2,
* Runtime dependencies: sqlite
### Running from source
First of all, clone the git repository to a directory
```
git clone https://git.project-insanity.org/onny/arch-upstream.git
```
Run the script
```
python main.py
```
Processing databases and packages will take a while but progress of it will be
indicated. After that, several report html pages will be present in the working
directory. These can be opened with the web browser of your choice.
## Reporting bugs
Bugs can be reported in the public [Gitlab repository](https://git.project-insanity.org/onny/arch-upstream/issues).
## Credits
* [Release-Monitoring](https://release-monitoring.org)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment