glap


Nameglap JSON
Version 0.3.1 PyPI version JSON
download
home_pagehttps://github.com/Mountlex/glap
SummaryGitLab Artifact Puller / Downloader
upload_time2021-02-26 10:35:56
maintainer
docs_urlNone
authorAlexander Lindermayr
requires_python>=3.7,<4.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # glap

![Python package](https://github.com/Mountlex/glap/workflows/Python%20package/badge.svg)
![PyPI](https://img.shields.io/pypi/v/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 a configuration file named `glap.toml`. `glap` searches the file at the following locations (in this order):

1. `./glap.toml`
2. `~/.config/glap/glap.toml` (default location for configuration files on your OS; here for Linux)

It contains the following information:

* Remotes with corresponding `url`s and access-tokens:

```toml
[remotes.myremote]
url = "https://gitlab.com"
private_token = "<my-private-token>"
oauth_token = "<my-oauth-token>"
job_token = "<my-job-token>"
```

Note that there must be exactly one authentication token specified.

* 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"
ref = "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> -j <job> --ref <branch or tag>
```

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.
* `--ref` specifies the name of the branch or tag from where the job is located.
* `--output` (`-o`) specifies the download location.
* `--temp` (`-t`) downloads the artifact to a temporary location and opens the directory.
* `--silent` (`-s`) enables silent mode (exceptions only).
* `--verbose` (`-v`) enables verbose mode (e.g. print file list).
  
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Mountlex/glap",
    "name": "glap",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Alexander Lindermayr",
    "author_email": "alexander.lindermayr97@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/80/e1/65224ef9fb0cbdfd013dd5664417a527c43c1c080b755c5ccdbb3a641df1/glap-0.3.1.tar.gz",
    "platform": "",
    "description": "# glap\n\n![Python package](https://github.com/Mountlex/glap/workflows/Python%20package/badge.svg)\n![PyPI](https://img.shields.io/pypi/v/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 a configuration file named `glap.toml`. `glap` searches the file at the following locations (in this order):\n\n1. `./glap.toml`\n2. `~/.config/glap/glap.toml` (default location for configuration files on your OS; here for Linux)\n\nIt contains the following information:\n\n* Remotes with corresponding `url`s and access-tokens:\n\n```toml\n[remotes.myremote]\nurl = \"https://gitlab.com\"\nprivate_token = \"<my-private-token>\"\noauth_token = \"<my-oauth-token>\"\njob_token = \"<my-job-token>\"\n```\n\nNote that there must be exactly one authentication token specified.\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\"\nref = \"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> -j <job> --ref <branch or tag>\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* `--ref` specifies the name of the branch or tag from where the job is located.\n* `--output` (`-o`) specifies the download location.\n* `--temp` (`-t`) downloads the artifact to a temporary location and opens the directory.\n* `--silent` (`-s`) enables silent mode (exceptions only).\n* `--verbose` (`-v`) enables verbose mode (e.g. print file list).\n  ",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "GitLab Artifact Puller / Downloader",
    "version": "0.3.1",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "31d77168c97c34274c61a5cac5e59e78",
                "sha256": "de037de4511b1b1abc643dd90057dc3c9351623c5c257d3ffbf54b9d2d0b4684"
            },
            "downloads": -1,
            "filename": "glap-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "31d77168c97c34274c61a5cac5e59e78",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<4.0",
            "size": 5296,
            "upload_time": "2021-02-26T10:35:54",
            "upload_time_iso_8601": "2021-02-26T10:35:54.511132Z",
            "url": "https://files.pythonhosted.org/packages/96/c5/68bc615f209e161d19d0ecf0306b654e2964a50ff9efabbf1228b30efd08/glap-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "cbd2d4ba83531bc74258f32b9497539e",
                "sha256": "a8e99e5795deeaa1cbff1af169f8a6fcb1715f22a2beaf5d7cbb4a8a7100742d"
            },
            "downloads": -1,
            "filename": "glap-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "cbd2d4ba83531bc74258f32b9497539e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<4.0",
            "size": 5077,
            "upload_time": "2021-02-26T10:35:56",
            "upload_time_iso_8601": "2021-02-26T10:35:56.148632Z",
            "url": "https://files.pythonhosted.org/packages/80/e1/65224ef9fb0cbdfd013dd5664417a527c43c1c080b755c5ccdbb3a641df1/glap-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-02-26 10:35:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "Mountlex",
    "error": "Could not fetch GitHub repository",
    "lcname": "glap"
}
        
Elapsed time: 0.19490s