| Name | giphon JSON |
| Version |
0.1.6
JSON |
| download |
| home_page | None |
| Summary | Copy locally a Gitlab group or instance |
| upload_time | 2022-12-30 18:13:34 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
clone
copy
gitlab
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
 [](https://pypi.org/project/black/) 
[](https://github.com/pypa/hatch)   
---
✨ Giphon is the contraction of 🦊 _Gitlab_ and 🫗 _siphon_. This CLI tools allows users
to recursively clone all projects in a given Gitlab group or instance.
## Motivation
This project aims to provide a tool capable of replicating a Gitlab group's
structure into a directory structure.
Locally cloned projects enable users to use familiar CLI tools such as `grep`
and `sed` directly into the projects' tree structure.
## Demo
## Installation
To install `giphon`, simply run:
```shq
pip install --user giphon
```
## Parameters
The `giphon` tool allows for the following parameters:
- **namespace** (CLI: `--namespace`): The Gitlab namespace to be cloned. `/`
defaults to the whole instance.
- **output** (CLI: `--output`): The target path to clone the repositories to.
- **gitlab_token**: (CLI: `--gitlab-token`, env: `GITLAB_TOKEN`): The Personal
Access Token authenticating the user.
- **gitlab_url**: (CLI: `--gitlab-url`, env: `GITLAB_URL`): The URL of the Gitlab
instance to clone the repositories from. Defaults to `"https://gitlab.com"`
- **fetch_repositories**: (CLI: `--fetch-repositories`/`--no-fetch-repositories`):
Whether to fetch remotes on repositories that already exist.
- **save_ci_variables**: (CLI: `--save-ci-variables`/`--no-save-ci-variables`):
Whether to download CI/CD variables to a .env directory.
- **clone_archived** (CLI: `--clone-archived`/`--no-clone-archived`): Whether
to also clone archived repository.
- **verbose**: (CLI: `--verbose`/`-v`): The level of verbosity
## Running programmatically
You can import the main function from `giphon` as such:
```python
from pathlib import Path
from giphon.siphon import siphon
siphon(
namespace=Path("my-namespace"),
output=Path("~/Projects"),
gitlab_token="",
gitlab_url="https://gitlab.com",
fetch_repositories=True,
save_ci_variables=False,
clone_archived=False,
verbose=False,
)
```
The function takes as inputs the same parameters from the CLI tool.
---
Logo is © from [**Midjourney**](https://midjourney.com)
Raw data
{
"_id": null,
"home_page": null,
"name": "giphon",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "clone,copy,gitlab",
"author": null,
"author_email": "Gabriel Creti <gabrielcreti@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/b5/7f/4f5c91b38622db671f7bdd8623b51930d3f0c54e7101318a4dd98f33af39/giphon-0.1.6.tar.gz",
"platform": null,
"description": "\n [](https://pypi.org/project/black/) \n[](https://github.com/pypa/hatch)   \n\n---\n\n\u2728 Giphon is the contraction of \ud83e\udd8a _Gitlab_ and \ud83e\uded7 _siphon_. This CLI tools allows users\nto recursively clone all projects in a given Gitlab group or instance.\n\n## Motivation\n\nThis project aims to provide a tool capable of replicating a Gitlab group's\nstructure into a directory structure.\n\nLocally cloned projects enable users to use familiar CLI tools such as `grep`\nand `sed` directly into the projects' tree structure.\n\n## Demo\n\n\n\n## Installation\n\nTo install `giphon`, simply run:\n\n```shq\npip install --user giphon\n```\n\n## Parameters\n\nThe `giphon` tool allows for the following parameters:\n\n- **namespace** (CLI: `--namespace`): The Gitlab namespace to be cloned. `/`\n defaults to the whole instance.\n- **output** (CLI: `--output`): The target path to clone the repositories to.\n- **gitlab_token**: (CLI: `--gitlab-token`, env: `GITLAB_TOKEN`): The Personal\n Access Token authenticating the user.\n- **gitlab_url**: (CLI: `--gitlab-url`, env: `GITLAB_URL`): The URL of the Gitlab\n instance to clone the repositories from. Defaults to `\"https://gitlab.com\"`\n- **fetch_repositories**: (CLI: `--fetch-repositories`/`--no-fetch-repositories`):\n Whether to fetch remotes on repositories that already exist.\n- **save_ci_variables**: (CLI: `--save-ci-variables`/`--no-save-ci-variables`):\n Whether to download CI/CD variables to a .env directory.\n- **clone_archived** (CLI: `--clone-archived`/`--no-clone-archived`): Whether\n to also clone archived repository.\n- **verbose**: (CLI: `--verbose`/`-v`): The level of verbosity\n\n## Running programmatically\n\nYou can import the main function from `giphon` as such:\n\n```python\nfrom pathlib import Path\n\nfrom giphon.siphon import siphon\n\nsiphon(\n namespace=Path(\"my-namespace\"),\n output=Path(\"~/Projects\"),\n gitlab_token=\"\",\n gitlab_url=\"https://gitlab.com\",\n fetch_repositories=True,\n save_ci_variables=False,\n clone_archived=False,\n verbose=False,\n)\n```\n\nThe function takes as inputs the same parameters from the CLI tool.\n\n---\n\nLogo is \u00a9 from [**Midjourney**](https://midjourney.com)\n",
"bugtrack_url": null,
"license": null,
"summary": "Copy locally a Gitlab group or instance",
"version": "0.1.6",
"split_keywords": [
"clone",
"copy",
"gitlab"
],
"urls": [
{
"comment_text": null,
"digests": {
"md5": "a09d3f7c4b2fb1d20598362b52e22390",
"sha256": "f6c95ff8a5bffc69db0bd204e1bf79e54d3acf0e611011ae953e70396b15b89e"
},
"downloads": -1,
"filename": "giphon-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a09d3f7c4b2fb1d20598362b52e22390",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 11882,
"upload_time": "2022-12-30T18:13:35",
"upload_time_iso_8601": "2022-12-30T18:13:35.624110Z",
"url": "https://files.pythonhosted.org/packages/b1/a8/a0a3b1dec9cbd50a3798cfda24a2f8750328235fde2d3b40629f9ccab22e/giphon-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"md5": "c79b95f3df7a7e852420c6d9e68e4728",
"sha256": "36c3e3811f2f6c976f03528ec790baa440a42e1043d10334b5b3ddb6263bc872"
},
"downloads": -1,
"filename": "giphon-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "c79b95f3df7a7e852420c6d9e68e4728",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 15063,
"upload_time": "2022-12-30T18:13:34",
"upload_time_iso_8601": "2022-12-30T18:13:34.372825Z",
"url": "https://files.pythonhosted.org/packages/b5/7f/4f5c91b38622db671f7bdd8623b51930d3f0c54e7101318a4dd98f33af39/giphon-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-30 18:13:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "giphon"
}
