Skip to main content

A tool to manage GitHub objects

Project description

GitHub Manager CLI (ghrm)

PyPI CI readthedocs License Code style: black

Overview

GitHub Manager CLI is a Python application designed to help users manage their GitHub repositories via YAML file definition.

Features

  • Create or delete repositories
  • Update repositories based on updated YAML config
  • Notifications via Slack and Discord

Installation

To install the required dependencies, run the following command:

pip install -r requirements/main.txt

To install the ghrm CLI tool, run the following command:

pip install uv
uv build
uv pip install -e .

Configuration

Create a .env file in the root directory of the project and add the following environment variables:

GITHUB_TOKEN=your_github_token
GITHUB_ORG=your_github_org
DISCORD_WEBHOOK_URL=your_discord_webhook
SLACK_WEBHOOK_URL=your_slack_webhook

Usage

To use the GitHub Repository Manager, you can run the grm command.

ghrm create --config repositories.yaml
ghrm delete --config delete_repositories.yaml

Vision

For more details on the vision and goals of this project, please refer to the VISION.md file.

Contributions

Long-term discussion and bug reports are maintained via GitHub Issues. Code review is done via GitHub Pull Requests.

For more information read CONTRIBUTING.md.

Code of Conduct

We are committed to fostering a welcoming and inclusive environment. Please read our Code of Conduct to understand our expectations for respectful participation.

By contributing to this project, you agree to abide by its terms.

Sponsors

Please contact me if you want to become a sponsor.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

github_manager_cli-0.1.tar.gz (45.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

github_manager_cli-0.1-py3-none-any.whl (36.6 kB view details)

Uploaded Python 3

File details

Details for the file github_manager_cli-0.1.tar.gz.

File metadata

  • Download URL: github_manager_cli-0.1.tar.gz
  • Upload date:
  • Size: 45.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.6

File hashes

Hashes for github_manager_cli-0.1.tar.gz
Algorithm Hash digest
SHA256 7214576f5dd4248a6b097ab61d232d30acea2ebd1e5b7ede7272dc6a86924c2f
MD5 36d920076fb885aa3e55b807ec6b29f1
BLAKE2b-256 425be885c5344d4ca0e39ff590f1ec9c0712a2df43c66ad4e4de70d78830ad12

See more details on using hashes here.

File details

Details for the file github_manager_cli-0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for github_manager_cli-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0d24a1426d93ce4a064ad14be2ff4a37b70632b645b590fc951f028240184d9b
MD5 0bb2a3d91fb1a751a85b92b5e5486064
BLAKE2b-256 7f9ea2ced89e67f42b6e6cd9f34654054dd30c3cd99b959c1025d6e8b556832d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page