Django app which automates the issue creation on Git for broken links.
Project description
=====
DJANGO GIT BROKENLINK TRACKING
=====
DJANGO GIT BROKENLINK TRACKING is a Django app which provides a middleware which can be used to generate Git Issue whenever the application encounters 404 page.
Detailed documentation is in the "docs" directory.
Quick start
-----------
1. Add "git_brokenlink_track" to your INSTALLED_APPS setting like this::
INSTALLED_APPS = [
...
'git_brokenlink_track',
]
2. Include "git_brokenlink_track.middleware.GitIssueTrackMiddleware" in the MIDDLEWARE_CLASSES like this::
MIDDLEWARE_CLASSES = [
...
'git_brokenlink_track.middleware.GitIssueTrackMiddleware',
]
3. Add DJANGO GIT BROKENLINK TRACKING settings in your settings file:
GBT_DEBUG_MODE = True # If set to true issues will be logged in debug mode as well, default False
GBT_REPO_OWNER = 'repo_owner'
GBT_REPO_NAME = 'repo_name'
GBT_ACCESS_TOKEN = 'user_access_token'
GBT_ISSUE_LABEL = [] # multiple labels can be specified in an array ['broken-link', '404']
4. Restart your development server
DJANGO GIT BROKENLINK TRACKING
=====
DJANGO GIT BROKENLINK TRACKING is a Django app which provides a middleware which can be used to generate Git Issue whenever the application encounters 404 page.
Detailed documentation is in the "docs" directory.
Quick start
-----------
1. Add "git_brokenlink_track" to your INSTALLED_APPS setting like this::
INSTALLED_APPS = [
...
'git_brokenlink_track',
]
2. Include "git_brokenlink_track.middleware.GitIssueTrackMiddleware" in the MIDDLEWARE_CLASSES like this::
MIDDLEWARE_CLASSES = [
...
'git_brokenlink_track.middleware.GitIssueTrackMiddleware',
]
3. Add DJANGO GIT BROKENLINK TRACKING settings in your settings file:
GBT_DEBUG_MODE = True # If set to true issues will be logged in debug mode as well, default False
GBT_REPO_OWNER = 'repo_owner'
GBT_REPO_NAME = 'repo_name'
GBT_ACCESS_TOKEN = 'user_access_token'
GBT_ISSUE_LABEL = [] # multiple labels can be specified in an array ['broken-link', '404']
4. Restart your development server
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for django_git_brokenlink_track-1.2.dev.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2e033fb53f8e0a93be419d9b3521236fbd2bb69258aaef1836901e822993b75 |
|
MD5 | fe2e4e176facf93380a183ba64e0c62e |
|
BLAKE2b-256 | e5ced5c69998954768bc803eeda803d4eacf2cefc8501eedbac2ca3f465d5237 |