# Django Endpoints
**Django Endpoints** is a small Django application that
displays your project's URLs, grouping them by
applications.
> Sometimes I use this in different projects, so I decided to put it on pypi
## Installation
```bash
pip install django-endpoints
```
## Settings
* ### Add the application to the project.
```python
INSTALLED_APPS = [
#...
'endpoints',
]
```
* ### In `settings.py` set the params
```python
# required * URL to which unauthenticated or non-staff users will be redirected (is_staff=False).
EP_NOT_AUTH_REDIRECT_URL = '/admin/login/?next=/endpoints/'
# A tuple of application names that you want to exclude from the list of URLs to display.
EP_EXCLUDED_APPS = (
'logui',
'swagger',
'rest_framework',
)
# Section with custom links
EP_CUSTOM_LINKS = [
{'name': 'Logs', 'url': 'https://xxx.xxx/logs/'},
{'name': 'Nginx', 'url': 'http://42.33.125.119:81/'},
{'name': 'Swagger', 'url': 'https://xxx.xxx/swagger/'},
{'name': 'Minio', 'url': 'https://minio.xxx.xxx/'},
{'name': 'Pg Admin', 'url': 'https://pgadmin.xxx.xxx/'},
{'name': 'Flower', 'url': 'https://flower.xxx.xxx/'},
]
```
* ### Add routes
Only `is_staff` have access.
```python
from django.urls import path, include
urlpatterns = [
#...
path('endpoints/', include('endpoints.urls')),
]
```
* ### Open https://localhost:8000/endpoints/
Raw data
{
"_id": null,
"home_page": "https://github.com/Artasov/django-endpoints",
"name": "django-endpoints",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "django urls endpoints",
"author": "xlartas",
"author_email": "ivanhvalevskey@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1a/74/1593fcfc7cb4825b384af6f7988e0015ded9ae4e5e51742b88a74f37b36b/django_endpoints-0.0.3.tar.gz",
"platform": null,
"description": "# Django Endpoints\r\n\r\n**Django Endpoints** is a small Django application that \r\ndisplays your project's URLs, grouping them by\r\napplications. \r\n> Sometimes I use this in different projects, so I decided to put it on pypi\r\n\r\n## Installation\r\n```bash\r\npip install django-endpoints\r\n```\r\n\r\n## Settings\r\n\r\n* ### Add the application to the project.\r\n ```python\r\n INSTALLED_APPS = [\r\n #...\r\n 'endpoints',\r\n ]\r\n ```\r\n* ### In `settings.py` set the params\r\n ```python\r\n # required * URL to which unauthenticated or non-staff users will be redirected (is_staff=False).\r\n EP_NOT_AUTH_REDIRECT_URL = '/admin/login/?next=/endpoints/'\r\n \r\n # A tuple of application names that you want to exclude from the list of URLs to display.\r\n EP_EXCLUDED_APPS = (\r\n 'logui',\r\n 'swagger',\r\n 'rest_framework',\r\n )\r\n \r\n # Section with custom links\r\n EP_CUSTOM_LINKS = [\r\n {'name': 'Logs', 'url': 'https://xxx.xxx/logs/'},\r\n {'name': 'Nginx', 'url': 'http://42.33.125.119:81/'},\r\n {'name': 'Swagger', 'url': 'https://xxx.xxx/swagger/'},\r\n {'name': 'Minio', 'url': 'https://minio.xxx.xxx/'},\r\n {'name': 'Pg Admin', 'url': 'https://pgadmin.xxx.xxx/'},\r\n {'name': 'Flower', 'url': 'https://flower.xxx.xxx/'},\r\n ]\r\n ```\r\n* ### Add routes\r\n\r\n Only `is_staff` have access.\r\n ```python\r\n from django.urls import path, include\r\n \r\n urlpatterns = [\r\n #...\r\n path('endpoints/', include('endpoints.urls')),\r\n ]\r\n ```\r\n* ### Open https://localhost:8000/endpoints/\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Package to display all URLs of a Django application",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/Artasov/django-endpoints",
"Source": "https://github.com/Artasov/django-endpoints",
"Tracker": "https://github.com/Artasov/django-endpoints/issues"
},
"split_keywords": [
"django",
"urls",
"endpoints"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "edea122ae9fe076c512dd190975243cec551cb388c2e8f37a6e8d5cd7d2a8399",
"md5": "b3ffb0239c4fc9f27e8e26c557a6894a",
"sha256": "d4181f065e0ac43cf96a933cd3d55833440fcb7d766da3b22d13f935aa2b4429"
},
"downloads": -1,
"filename": "django_endpoints-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b3ffb0239c4fc9f27e8e26c557a6894a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 43752,
"upload_time": "2024-10-07T11:11:48",
"upload_time_iso_8601": "2024-10-07T11:11:48.449898Z",
"url": "https://files.pythonhosted.org/packages/ed/ea/122ae9fe076c512dd190975243cec551cb388c2e8f37a6e8d5cd7d2a8399/django_endpoints-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1a741593fcfc7cb4825b384af6f7988e0015ded9ae4e5e51742b88a74f37b36b",
"md5": "0356c5fdac12c295db10045ce517d6fb",
"sha256": "19b67e2e66a1ed83d1a223fe1b9fae13f9c0ad6dde7bcdefc15e244d44e568d2"
},
"downloads": -1,
"filename": "django_endpoints-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "0356c5fdac12c295db10045ce517d6fb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 42791,
"upload_time": "2024-10-07T11:11:50",
"upload_time_iso_8601": "2024-10-07T11:11:50.070753Z",
"url": "https://files.pythonhosted.org/packages/1a/74/1593fcfc7cb4825b384af6f7988e0015ded9ae4e5e51742b88a74f37b36b/django_endpoints-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 11:11:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Artasov",
"github_project": "django-endpoints",
"github_not_found": true,
"lcname": "django-endpoints"
}
JSON
