Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/magnetikonline/github-utilities
Random scripts for working with GitHub itself and repositories within.
https://github.com/magnetikonline/github-utilities
github github-api python
Last synced: 2 days ago
JSON representation
Random scripts for working with GitHub itself and repositories within.
- Host: GitHub
- URL: https://github.com/magnetikonline/github-utilities
- Owner: magnetikonline
- License: mit
- Created: 2016-07-27T08:14:20.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-05-09T01:29:07.000Z (6 months ago)
- Last Synced: 2024-05-09T02:35:42.711Z (6 months ago)
- Topics: github, github-api, python
- Language: Python
- Homepage:
- Size: 84 KB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub utilities
Random scripts for working with GitHub itself and repositories. All designed for Python 3.10+.
- [Utilities](#utilities)
- [listorganizationrepositorybysize.py](#listorganizationrepositorybysizepy)
- [listorganizationrepositorywebhooks.py](#listorganizationrepositorywebhookspy)
- [removerepositorywiki.py](#removerepositorywikipy)
- [removerepositoryprojects.py](#removerepositoryprojectspy)
- [subscriberepositories.py](#subscriberepositoriespy)
- [Configuration](#configuration)
- [Filter arguments](#filter-arguments)
- [Examples](#examples)
## Utilities
### [`listorganizationrepositorybysize.py`](listorganizationrepositorybysize.py)
- Fetches all repositories for a given `ORGANIZATION`, ordered in descending size order.
- Emits results to the console as tab separated repository/size (kilobytes) lines.
### [`listorganizationrepositorywebhooks.py`](listorganizationrepositorywebhooks.py)
- Returns all repositories for a given `ORGANIZATION` containing one or more webhooks.
- Emits results to the console as repository lines and tab indented webhook URLs.
### [`removerepositorywiki.py`](removerepositorywiki.py)
- Scans repositories and reports all with an enabled [Wiki](https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis).
- Repository checking scope can be set with the `--include` / `--exclude` [filter arguments](#filter-arguments).
- With `--commit` argument passed will disable each wiki found.
### [`removerepositoryprojects.py`](removerepositoryprojects.py)
- Scans repositories and reports all with an enabled [Projects](https://docs.github.com/en/github/managing-your-work-on-github/about-project-boards) board.
- Repository checking scope can be set with the `--include` / `--exclude` [filter arguments](#filter-arguments).
- With `--commit` argument passed will disable each project board found.
### [`subscriberepositories.py`](subscriberepositories.py)
- By default GitHub [notification settings](https://github.com/settings/notifications) are configured to automatically watch all repositories to which you have _push access_ - including your own personal repositories:
- This state works well when running solo, but association to an active organization you soon find a watch list getting very noisy with notifications.
- Disabling `Automatic watching` works, but you're now left in a situation of potentially forgetting to watch *your own* personal repositories after creation and update of issues/PRs.
- This script fetches all repositories in scope and compares to your subscription list - reporting back repositories that aren't currently watched.
- Repository checking scope can be set with the `--include` / `--exclude` [filter arguments](#filter-arguments).
- With `--commit` argument passed any repositories not currently watched will be subscribed to.
## Configuration
All settings contained in a single [`config.json`](config.json). A breakdown of each setting follows:
- `AUTH_TOKEN` - a valid GitHub token ID, generated via the [Personal access tokens](https://github.com/settings/tokens) page. Token requires full access to the `repo` scope and it's sub-scopes:
Alternatively, the token value can be supplied via a `AUTH_TOKEN` environment variable.
- `ORGANIZATION` - where required, specifies the organization to use for repository fetch.
- `REPOSITORY_TYPE` - when repositories are fetched - defines the context/association to to user to use.
Valid options [are listed here](https://docs.github.com/en/rest/reference/repos#list-organization-repositories) and [here](https://docs.github.com/en/rest/repos/repos#list-repositories-for-the-authenticated-user) with `member` or `owner` more than likely what you're after.
## Filter arguments
Certain scripts allow control of repository scope via `--include` and `--exclude` arguments, providing the ability to skip over a subset of repositories:
- Valid filter character range is `[/A-Za-z0-9_.-]`, while a wildcard (`*`) will match one or more characters.
- Filters will be evaluated against a full `user/repository_name` or `organization/repository_name` value.
- An `--exclude` match will negate any possible `--include` match(es).
- If no `--include` filter(s) defined, default is to "match all" (e.g. `--include *`).
### Examples
```sh
# matches "user/one" and "user/two" but not "user/one_two" or "user/three"
./script.py \
--include "u*/one" \
--include "u*/two"
# matches "organization/*" but not "organization/skip_me"
./script.py \
--include "organization/*" \
--exclude "*/skip_me"
# will match everything except "user/avoid"
./script.py \
--exclude "user/avoid"
```