Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pygitmirror/pygitmirror
A python package for mirroring git repositories between two git servers
https://github.com/pygitmirror/pygitmirror
clone git gitea github gitlab mirror
Last synced: 13 days ago
JSON representation
A python package for mirroring git repositories between two git servers
- Host: GitHub
- URL: https://github.com/pygitmirror/pygitmirror
- Owner: pygitmirror
- License: mit
- Created: 2024-10-01T21:43:33.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-10-04T01:40:35.000Z (3 months ago)
- Last Synced: 2024-10-11T13:37:27.152Z (3 months ago)
- Topics: clone, git, gitea, github, gitlab, mirror
- Language: Python
- Homepage: https://github.com/pygitmirror/pygitmirror
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Git Mirror
[](https://pypi.org/project/pygitmirror/)
[](https://pepy.tech/project/pygitmirror)
[](https://pepy.tech/project/pygitmirror)
[](https://pepy.tech/project/pygitmirror)
`git-mirror` is part of the `pygitmirror` Python package. `git-mirror` is an executable to clone git repos from one git server to another.
## Installation
To install `pygitmirror` into your Python environment:
pip install -U pygitmirror
The package exposes a single executable `git-mirror` which is used to systematically mirror your git repos from one `git` server to another.
## Usage
After installing `pygitmirror`, you can call the `git-mirror` executable to clone/mirror your `git` repository between two git servers:
git-mirror --source_url --destination_url --org --repo
`git-mirror` will use the current directory to check out your source repository and pushes **all branches** in it to its new location at the destination. Note, the destination repository needs to **_already exist_** at the destination server, albeit being empty!
To use a custom sync/temporary path:
git-mirror --sync_path ..
To mirror multiple repositories at once, you should use the `JSON` file option:
```json
{
"sync_path": "",
"source_url": "ssh://: or https://",
"destination_url": "ssh:// or https://",
"repos": {
// comments are allowed at the beginning
"organization-1": [
// comments are allowed at the beginning
"repo-1",
"repo-2",
"..."
],
"organization-2": ["repo-3", "repo-4", "..."]
}
}
```
Note: `JSON` file entries supersede the other command line arguments.
To get a list of all available parameters:
git-mirror -h
## Development
To clone the library for development:
git clone https://github.com/pygitmirror/pygitmirror.git
or
git clone [email protected]:pygitmirror/pygitmirror.git
### Build The Virtual Environment
The current earliest Python version supported is `3.9`. You need to be able to create a virtual environment at this version to make sure any changes you make is compatible.
If you are using `conda`:
conda create --prefix=.venv python=3.9 --yes
If you are using `venv`, make sure you have the right base package:
>> python --version
Python 3.9.x
Once you verify your base Python, you can then create a virtual environment using:
virtualenv -p py3.9 .venv
### Setup
Once you have created your virtual environment and made sure it is active in your current command line:
python3 -m pip install --upgrade pip
pip install -e .[dev]
This should all the dependencies you need for developing into the library and also allow you to run the unit tests:
pytest