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.

Files for lektor-gitlab, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size lektor_gitlab-0.1.0-py3-none-any.whl (2.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size lektor-gitlab-0.1.0.tar.gz (1.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page