# GitHub Issue Reporter
**GitHub Issue Reporter** is a Django module that enables users to create and submit issues directly to a GitHub repository from a Django web application.
---
## Installation
1. Install the package using pip:
```bash
pip install github-issue-reporter
```
2. Add the module to your Django project's `INSTALLED_APPS` in `settings.py`:
```python
INSTALLED_APPS = [
...,
'github_issue_reporter',
]
```
---
## Configuration
Add the following configuration settings to your `settings.py` file:
```python
GITHUB_REPO_NAME = "repo_name_without_extension" # Replace with your repository name
GITHUB_USER = "github_username" # Replace with your GitHub username
GITHUB_API_TOKEN = "github_api_token" # Replace with your GitHub API token
```
### Notes:
- **`GITHUB_REPO_NAME`**: This is the name of your GitHub repository.
- **`GITHUB_USER`**: Your GitHub username.
- **`GITHUB_API_TOKEN`**: A personal access token generated from GitHub. (See [GitHub Personal Access Tokens](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token))
---
## Usage
### URL Configuration
At the project level, include `github_issue_reporter.urls` in your `urls.py` file:
```python
from django.urls import path, include
urlpatterns = [
...,
path('module/', include('github_issue_reporter.urls')),
]
```
### Accessing the Issue Reporter
Once the module is included, you can access the issue reporting page by visiting:
```
http://<your-domain>/module/report-issue/
```
---
## Features
- **GitHub Integration**: Submit issues directly to your repository’s issue tracker.
- **Simple Setup**: Configure and start using the module with minimal effort.
- **Django Templating**: Customize the provided HTML templates to suit your application.
---
## Customization
You can override the default template `report_issue.html` by creating a custom version in your project. Place the custom template at the following path:
```
<your_app>/templates/github_issue_reporter/report_issue.html
```
Raw data
{
"_id": null,
"home_page": "https://github.com/thimpu-create/git_issue_reporter.git",
"name": "git-issue-reporter",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Thimpu Sengyung",
"author_email": "thmtymthm@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/79/5e/e2def2859c1a87244a65f662001ad502610981c55beac3768a24123a8bfa/git_issue_reporter-1.1.0.tar.gz",
"platform": null,
"description": "# GitHub Issue Reporter\r\n\r\n**GitHub Issue Reporter** is a Django module that enables users to create and submit issues directly to a GitHub repository from a Django web application.\r\n\r\n---\r\n\r\n## Installation\r\n\r\n1. Install the package using pip:\r\n ```bash\r\n pip install github-issue-reporter\r\n ```\r\n\r\n2. Add the module to your Django project's `INSTALLED_APPS` in `settings.py`:\r\n ```python\r\n INSTALLED_APPS = [\r\n ...,\r\n 'github_issue_reporter',\r\n ]\r\n ```\r\n\r\n---\r\n\r\n## Configuration\r\n\r\nAdd the following configuration settings to your `settings.py` file:\r\n\r\n```python\r\nGITHUB_REPO_NAME = \"repo_name_without_extension\" # Replace with your repository name\r\nGITHUB_USER = \"github_username\" # Replace with your GitHub username\r\nGITHUB_API_TOKEN = \"github_api_token\" # Replace with your GitHub API token\r\n```\r\n\r\n### Notes:\r\n- **`GITHUB_REPO_NAME`**: This is the name of your GitHub repository.\r\n- **`GITHUB_USER`**: Your GitHub username.\r\n- **`GITHUB_API_TOKEN`**: A personal access token generated from GitHub. (See [GitHub Personal Access Tokens](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token))\r\n\r\n---\r\n\r\n## Usage\r\n\r\n### URL Configuration\r\nAt the project level, include `github_issue_reporter.urls` in your `urls.py` file:\r\n\r\n```python\r\nfrom django.urls import path, include\r\n\r\nurlpatterns = [\r\n ...,\r\n path('module/', include('github_issue_reporter.urls')),\r\n]\r\n```\r\n\r\n### Accessing the Issue Reporter\r\nOnce the module is included, you can access the issue reporting page by visiting:\r\n```\r\nhttp://<your-domain>/module/report-issue/\r\n```\r\n\r\n---\r\n\r\n## Features\r\n- **GitHub Integration**: Submit issues directly to your repository\u00e2\u20ac\u2122s issue tracker.\r\n- **Simple Setup**: Configure and start using the module with minimal effort.\r\n- **Django Templating**: Customize the provided HTML templates to suit your application.\r\n\r\n---\r\n\r\n## Customization\r\nYou can override the default template `report_issue.html` by creating a custom version in your project. Place the custom template at the following path:\r\n```\r\n<your_app>/templates/github_issue_reporter/report_issue.html\r\n```\r\n\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A Django module to report issues directly to GitHub.",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/thimpu-create/git_issue_reporter.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "795ee2def2859c1a87244a65f662001ad502610981c55beac3768a24123a8bfa",
"md5": "046fbb5f2b130645ffd210d1bacc5a06",
"sha256": "829202884d822530d89ac109fcc5a20a2ad0fd2a422877245f462efef966cf86"
},
"downloads": -1,
"filename": "git_issue_reporter-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "046fbb5f2b130645ffd210d1bacc5a06",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4046,
"upload_time": "2025-01-11T05:36:00",
"upload_time_iso_8601": "2025-01-11T05:36:00.819111Z",
"url": "https://files.pythonhosted.org/packages/79/5e/e2def2859c1a87244a65f662001ad502610981c55beac3768a24123a8bfa/git_issue_reporter-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-11 05:36:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thimpu-create",
"github_project": "git_issue_reporter",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "git-issue-reporter"
}
JSON
