# glap
A GitLab Artifact Puller / Downloader
## Quick Start
`glap` is a convenience tool to download artifacts of your frequently used GitLab repositories. Install via
```bash
pip install glap
```
Before you can use `glap`, you have to setup your configuration file located at `~/.config/glap/glap.toml`. It contains the following information.
* Remotes with corresponding `url`s and access-tokens (`token`):
```toml
[remotes.myremote]
url = "https://gitlab.com"
token = "<my-access-token>"
```
* Shortcuts for specific repositories. For example, the following shortcut points at the `PDFs` job of the `main` branch of `https://gitlab.com/name/repo`.
```toml
[shortcuts.myshortcut]
remote = "myremote"
namespace = "name"
repository = "repo"
branch = "main"
job = "PDFs"
```
Any configured shortcut will appear as a subcommand, i.e. you can use it as follows
```bash
glap myshortcut
```
Alternatively, you can specify the namespace and repository directly
```bash
glap download <namespace> <repository>
```
If no remote is given, `glap` will use the first one in the configuration file. Otherwise, you can use
```bash
glap download <namespace> <repository> -r myremote
```
where `myremote` is the name of the remote in the configuration file.
### Options
* `--job` (`-j`) specifies the job's name.
* `--branch` (`-b`) specifies the branch's name.
* `--output` (`-o`) specifies the download location.
* `--temp` (`-t`) downloads the artifact to a temporary location and opens the directory.
Raw data
{
"_id": null,
"home_page": "https://github.com/Mountlex/glap",
"name": "glap",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Alexander Lindermayr",
"author_email": "alexander.lindermayr97@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0d/cc/87c8d0356dc5a12e8a29b16b5a4ea45b270ae7447526686f17c14a8d24c1/glap-0.1.4.tar.gz",
"platform": "",
"description": "# glap\n\nA GitLab Artifact Puller / Downloader\n\n## Quick Start\n\n`glap` is a convenience tool to download artifacts of your frequently used GitLab repositories. Install via\n\n```bash\npip install glap\n```\n\nBefore you can use `glap`, you have to setup your configuration file located at `~/.config/glap/glap.toml`. It contains the following information.\n\n* Remotes with corresponding `url`s and access-tokens (`token`):\n\n```toml\n[remotes.myremote]\nurl = \"https://gitlab.com\"\ntoken = \"<my-access-token>\"\n```\n\n* Shortcuts for specific repositories. For example, the following shortcut points at the `PDFs` job of the `main` branch of `https://gitlab.com/name/repo`.\n\n```toml\n[shortcuts.myshortcut]\nremote = \"myremote\"\nnamespace = \"name\"\nrepository = \"repo\"\nbranch = \"main\"\njob = \"PDFs\"\n```\n\nAny configured shortcut will appear as a subcommand, i.e. you can use it as follows\n\n```bash\nglap myshortcut\n```\n\nAlternatively, you can specify the namespace and repository directly\n\n```bash\nglap download <namespace> <repository>\n```\n\nIf no remote is given, `glap` will use the first one in the configuration file. Otherwise, you can use\n\n```bash\nglap download <namespace> <repository> -r myremote\n```\n\nwhere `myremote` is the name of the remote in the configuration file.\n\n### Options\n\n* `--job` (`-j`) specifies the job's name.\n* `--branch` (`-b`) specifies the branch's name.\n* `--output` (`-o`) specifies the download location.\n* `--temp` (`-t`) downloads the artifact to a temporary location and opens the directory.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A GitLab Artifact Puller / Downloader",
"version": "0.1.4",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "b176cc2d733ee5931bbb1bbc0a984235",
"sha256": "c1cb0c9a1e68106d0ee2e0f8087d2c385dadc5c352028ce13bc77a3f10cc22e5"
},
"downloads": -1,
"filename": "glap-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b176cc2d733ee5931bbb1bbc0a984235",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4613,
"upload_time": "2020-11-26T13:29:55",
"upload_time_iso_8601": "2020-11-26T13:29:55.666863Z",
"url": "https://files.pythonhosted.org/packages/37/69/562a3157edb0723a69762ec43cc6095a236c01193906277c82b1424f6b4a/glap-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "91d8dd8f53c9720f0435f6a9b2c9b669",
"sha256": "dbe3780ecadc20e80d0dccc00e3ed03e0656b737fc4a419bca92f010c71bc457"
},
"downloads": -1,
"filename": "glap-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "91d8dd8f53c9720f0435f6a9b2c9b669",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4118,
"upload_time": "2020-11-26T13:29:56",
"upload_time_iso_8601": "2020-11-26T13:29:56.712148Z",
"url": "https://files.pythonhosted.org/packages/0d/cc/87c8d0356dc5a12e8a29b16b5a4ea45b270ae7447526686f17c14a8d24c1/glap-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-11-26 13:29:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": null,
"github_project": "Mountlex",
"error": "Could not fetch GitHub repository",
"lcname": "glap"
}
JSON
