Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dcermak/release-notes-scraper
Grab the changelog from releases on Github
https://github.com/dcermak/release-notes-scraper
Last synced: 29 days ago
JSON representation
Grab the changelog from releases on Github
- Host: GitHub
- URL: https://github.com/dcermak/release-notes-scraper
- Owner: dcermak
- License: gpl-3.0
- Created: 2021-12-08T13:25:00.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T18:34:17.000Z (8 months ago)
- Last Synced: 2024-05-22T19:46:18.792Z (8 months ago)
- Language: Python
- Size: 182 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-package-maintainer - release-notes-scraper - grab the release notes for projects from GitHub that do not keep a CHANGELOG, but publish their release notes via the releases page. (readelf and objdump / Using ltrace to trace both userspace library calls, syscalls, and collect stack traces)
README
# release-notes-scraper
This simple script can be used to grab the release notes for projects from
github that do not keep a `CHANGELOG`, but publish their release notes via the
releases page.
## Prerequisites
You will need the following tools:
- Python 3.10 or later
- [`poetry`](https://python-poetry.org/)
Additionally, you have to clone this repository and initialize poetry:
```ShellSession
❯ git clone https://github.com/dcermak/release-notes-scraper.git
❯ poetry install
```
## Usage
To grab the changelog of a the project `octocat/foobar`, run:
```ShellSession
❯ poetry run ./release-notes-scraper.py octocat foobar
1.0.5
- We did cool stuff!
```
You can also specify the maximum version to be included in the output via the
CLI flag `--max-version` and the minimum version that should **not** be included
(i.e. the next release after `$min_version` will be present) in the output via
the CLI flag `--min-version`:
```ShellSession
❯ poetry run ./release-notes-scraper.py octocat foobar --min-version 1.0.5
```