Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tisma95/github-clone
This repository goal is to clone/pull all repositories of github associate to the user to specific location.
https://github.com/tisma95/github-clone
github github-actions python python3
Last synced: 2 months ago
JSON representation
This repository goal is to clone/pull all repositories of github associate to the user to specific location.
- Host: GitHub
- URL: https://github.com/tisma95/github-clone
- Owner: tisma95
- License: apache-2.0
- Created: 2023-07-09T11:08:48.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-28T21:19:11.000Z (3 months ago)
- Last Synced: 2024-10-28T22:24:54.621Z (3 months ago)
- Topics: github, github-actions, python, python3
- Language: Python
- Homepage:
- Size: 546 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Github Repository Clone
## Author
**Name**: Ismaël Maurice
**Github**: https://github.com/tisma95
**Email**: [email protected]
## Description
This repository goal is to clone all repositories of github associate to the user:
+ the personal user repositories private and public,
+ the user organization repositories,
+ the ancestor repositories,
+ the fork repositories.
If the repository existed pull to update will be.
Clone all branchs in folder.
**WARNING:**
The repository name with space will be replace in clone folder by -. Example the repository name like **repo 1** will be clone with name **repo-1**.
## Requirement
Before starting the project you need to install on your computer the following packages:
[Python >=3.9](https://www.python.org/downloads/)
[Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
## Started
Run the commands inside the folder:
1. If no **env** folder exists init the environment else skip this step
```cmd
python -m venv env
```
or
```cmd
python3 -m venv env
```
or for ubuntu
```cmd
virtualenv venv
```
```node
If any problem follow this page to fix and intall virutalenv: https://gist.github.com/frfahim/73c0fad6350332cef7a653bcd762f08d
```
2. If the env folder already exists, run the following command to activate it
```cmd
source env/bin/activate
```
or for windows
```cmd
env\Scripts\activate.bat
```
3 Run the installation of package via following command
```cmd
pip install -r requirements.txt
```
4. Init the environment variable by following [Environment variables](#environment-variables)
5. Create the token on your **Github** access only read access is required choose between:
+ Token via [Fine-grained personal access tokens](https://github.com/settings/tokens?type=beta) with following authorization:
+ Token via [Personal access token (classic)](https://github.com/settings/tokens/new) with following authorization (only repo):
> **Warning**
> If you have the fork repository, should give the workflow authorization to permits to synchronize the fork repository before clone it. Like following image:
6. Run the script with command `python main.py` or `python3 main.py`
## Environment variables ##
Create the file **.env** inside folder with following example variable
```yaml
# Clone repo host
DOMAIN = github.com
# Domain protocol type http or https
PROTOCOL = https
# Access Token To Domain
TOKEN = your_generate_token_here
# Storage Folder => Folder where the repositories will be save => example /home/toto or C:\users\toto for windows
FOLDER = folder_path_here
```
## Other informations
+ If new package is install we can update the **requirements.txt** with command `pip freeze > requirements.txt` or `python3 -m pip freeze > requirements.txt`
+ Exit the env via: `deactivate` or for windows `env\Scripts\activate.bat`
## Useful packages
[Requests Documentation](https://requests.readthedocs.io/en/latest/user/quickstart/)
[Github REST API Documentation](https://docs.github.com/en/rest?apiVersion=2022-11-28)
[python-dotenv Documentation](https://pypi.org/project/python-dotenv/)