Skip to main content

Query the Gitlab API right from your Lektor templates

Project description

# Lektor Gitlab

Query the Gitlab API right from your [Lektor][1] templates.

## Configuration

To use the plugin you must first acquire an [private access token][2].
The token must at least have the `api` scope.

Depending on your preference you can either create a Lektor config file
called `configs/gitlab.ini` where the token is stored under the
`private_token` key.

Eg:
```ini
private_token = <Your access token>
```

Alternatively the token can also be set using an environment variable.

__Note__: the config file is checked before the environment variable

Eg:
```bash
export GITLAB_PRIVATE_TOKEN=<Your access token>
```

## Usage

After you have set up the access token, the [Python-Gitlab][3] `Gitlab`
object is available in your templates. This means you can do anything
your heart desires with it.

### Examples

List your public repos

```jinja2
<ul>
{% for project in gitlab.projects.list(owned=True, visibility='public') %}
<li>{{ project.name }} [{{ project.star_count }}]</li>
{% endfor %}
</ul>
```

Display the your name and avatar

```jinja2
<h2>{{ gitlab.user.name }}</h2>
<img src="{{ gitlab.user.avatar_url }}">
```

[1]: https://www.getlektor.com
[2]: https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
[3]: http://python-gitlab.readthedocs.io/en/stable/index.html

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lektor-gitlab-0.1.0.tar.gz (1.9 kB view details)

Uploaded Source

Built Distribution

lektor_gitlab-0.1.0-py3-none-any.whl (2.2 kB view details)

Uploaded Python 3

File details

Details for the file lektor-gitlab-0.1.0.tar.gz.

File metadata

File hashes

Hashes for lektor-gitlab-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7e3fd6b8571acf1837054d2159234644a4987fbae07ffeb3a8dbe47ae0773175
MD5 8d3d5b5b3c17a4e02c81cc0b409afb43
BLAKE2b-256 9951565b03f483ff36542ffc8fcde1f3dee262ff9cdbbbca3b3b285d037d08e8

See more details on using hashes here.

File details

Details for the file lektor_gitlab-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for lektor_gitlab-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f230cefe8d2c177225e00f7aad1c8e657407a48522141d53668d5a75b7d5dc68
MD5 64c4d8fb6308390a35923254544129a5
BLAKE2b-256 0b7f6348b167b7987aedf4b1d437d9b97e024897f321b78fd975b4367d304d8f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page