https://github.com/pablolec/django-github-tags
Access to GitHub API using tags in your Django templates.
https://github.com/pablolec/django-github-tags
Last synced: 8 months ago
JSON representation
Access to GitHub API using tags in your Django templates.
- Host: GitHub
- URL: https://github.com/pablolec/django-github-tags
- Owner: PabloLec
- License: gpl-3.0
- Created: 2021-05-31T13:34:25.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-03-03T15:23:13.000Z (over 4 years ago)
- Last Synced: 2025-03-03T21:15:14.596Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 198 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# django-github-tags [](https://github.com/PabloLec/django-github-tags/releases/) [](https://github.com/PabloLec/django-github-tags/blob/main/LICENCE)
Access to GitHub API using tags in your Django templates.
## Installation
```python3 -m pip install django-github-tags```
## Configuration
To integrate `django-github-tags` into your Django project, add it to your `INSTALLED_APPS` in your `settings.py` file:
``` python
INSTALLED_APPS = [
...,
'django_github_tags'
]
```
:warning: Take notice of underscore/hyphens. Package name uses hyphens due to `pip` requirements while django uses underscore. :warning:
## Usage
This app is simple and goes straight to the point. It lets you use Django template tags as GitHub API queries.
To use it in your template `.html` file, add:
```
{% load django_github_tags %}
```
There are two possible tags: `github` and `github-raw`.
### `github`
**This tag requires an endpoint path and a key to search into the API response. The output will be a string.**
Typical usage is:
```
{% github "API_ENDPOINT" "PATH_ARG1" "PATH_ARG2" "PATH_ARGX" "KEY" %}
```
For example, to access [recoverpy](https://github.com/PabloLec/recoverpy) repository programming language, you can use:
```
Monty {% github "repos" "pablolec" "recoverpy" "language" %}
```
And Django will generate:
```
Monty Python
```
### `github-raw`
**This tag requires only an endpoint path. The output will be a dictionary.**
Typical usage is:
```
{% github "API_ENDPOINT" "PATH_ARG1" "PATH_ARG2" "PATH_ARGX" %}
```
For example, to manipulate my own GitHub profile, I can use:
```
{% github-raw "users" "pablolec" as myprofile %}
Check out my cool profile at: {% myprofile.html_url %}
And by the way, I live in {% myprofile.location %}.
```
And Django will generate:
```
Check out my cool profile at: https://github.com/PabloLec
And by the way, I live in France.
```
## General Principle
Anything you can do with GET requests and GitHub REST API, you can also do it with `django-github-tags`. And that's a lot.
**To have a full tour of the API capabilities, refer to the [official documentation](https://docs.github.com/en/rest).**
Keep in mind that if you want to get a simple string result for one particular key, use the `github` command.
If you want the full API response to use it as a dictionary, use `github-raw` command.
## Examples
There is of course an infinity of potential usage:
- Provide users dynamic GitHub profile data.
- Display a repo stars, fork count, etc.
- Track latest issue.
- Add to a user profile its assigned issues or send notifications.
- Get newest PR commits, comments.
- Sync users profile pic with GitHub's pic.
- List latest `good first issue` labels.
- A GitHub [insert your filter] search engine
- etc.
Well, the only limit is your imagination (and [documentation](https://docs.github.com/en/rest)).
## License
django-github-tags is released under the [GPL-3.0 License](https://github.com/PabloLec/django-github-tags/blob/main/LICENCE).