No project description provided
Project description
GitHub-Backup
Project description
Application for backing up information about a GitHub organization
Installation
You can clone this repository and set up the environment directly from the command line using the following command:
git clone git@github.com:cloud-labs-infra/github-backup.git
cd github-backup
poetry install
Testing
You can run the tests using the following command:
poetry run pytest --cov=./ --cov-report=xml
This command runs all unit tests and calculates coverage
Usage
CLI Usage is as follows:
poetry run backup-github [-h] [-t TOKEN] [-o OUTPUT_DIR] [-r REPOSITORY [REPOSITORY ...]] [-i] [-p] [-m]
[--all]
ORGANIZATION_NAME
Backup a GitHub organization
positional arguments:
ORGANIZATION_NAME github organization name
options:
-h, --help show this help message and exit
-t TOKEN, --token TOKEN
personal token
-o OUTPUT_DIR, --output-directory OUTPUT_DIR
directory for backup
-r REPOSITORY [REPOSITORY ...], --repository REPOSITORY [REPOSITORY ...]
name of repositories to limit backup
-i, --issues run backup of issues
-p, --pulls run backup of pulls
-m, --members run backup of members
--all run backup of all data
Backup structure
.
└── organization
├── members
│ └── login1
│ ├── member.json
│ └── membership.json
└── repos
└── repo1
├── content
│ └── repo1.git
├── issues
│ └── 1
│ ├── assignee.json
│ ├── comments
│ ├── issue.json
│ └── user.json
├── pulls
│ └── 2
│ ├── assignee.json
│ ├── base.json
│ ├── comments
│ │ └── 1
│ │ ├── comment.json
│ │ └── user.json
│ ├── head.json
│ ├── pull.json
│ ├── reviews
│ │ ├── 1
│ │ │ ├── review.json
│ │ │ └── user.json
│ │ └── 2
│ │ ├── comments
│ │ │ └── 1
│ │ │ ├── comment.json
│ │ │ └── user.json
│ │ ├── review.json
│ │ └── user.json
│ └── user.json
└── repo.json
Project status
The project is currently in a development state
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for backup_github_org-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f33dcf3d8f1affec63565a31adf8190a5bad116df47c938ab1b8754dde4ab7a |
|
MD5 | 9867e46cfce1aaf2fbfe7dca209a7e02 |
|
BLAKE2b-256 | ed18ca1ea4213dc500477830b10875b8e7446675c86befcf3d82d45cac0f94d4 |