{"id":21513797,"url":"https://github.com/andrei-demidov/django-permalinker","last_synced_at":"2026-02-08T07:05:45.634Z","repository":{"id":257251151,"uuid":"857745571","full_name":"andrei-demidov/django-permalinker","owner":"andrei-demidov","description":"Django application to create, manage, and redirect permanent links","archived":false,"fork":false,"pushed_at":"2024-09-15T17:24:04.000Z","size":1542,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-17T04:44:03.380Z","etag":null,"topics":["django","django-app","django-application","django-apps","django-permalinks","django-url-shortener","python","python-package","python-packages"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andrei-demidov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-15T13:59:16.000Z","updated_at":"2025-07-09T20:57:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"336831b2-83de-44f2-8dae-5ebbb8ad551a","html_url":"https://github.com/andrei-demidov/django-permalinker","commit_stats":null,"previous_names":["efficient-solutions/django-permalinker","andrei-demidov/django-permalinker"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/andrei-demidov/django-permalinker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrei-demidov%2Fdjango-permalinker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrei-demidov%2Fdjango-permalinker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrei-demidov%2Fdjango-permalinker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrei-demidov%2Fdjango-permalinker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andrei-demidov","download_url":"https://codeload.github.com/andrei-demidov/django-permalinker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrei-demidov%2Fdjango-permalinker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29224431,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-08T06:05:31.539Z","status":"ssl_error","status_checked_at":"2026-02-08T05:58:33.853Z","response_time":57,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","django-app","django-application","django-apps","django-permalinks","django-url-shortener","python","python-package","python-packages"],"created_at":"2024-11-23T23:17:12.599Z","updated_at":"2026-02-08T07:05:45.613Z","avatar_url":"https://github.com/andrei-demidov.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Django Permalinker\n\n`django_permalinker` is a Django application that provides an easy way to create, manage, and redirect permanent links (or permalinks). With customizable permalink ID generation, this app ensures that you have unique and efficient IDs to serve your redirecting needs.\n\n## Features\n\n- **Customizable Permalink ID Generation**: Adjust ID length, character set (uppercase, lowercase, digits), and more through Django settings.\n- **Admin Interface**: Manage links via Django's admin panel.\n- **404 Handling**: Automatically raise 404 errors for invalid or missing links.\n- **Automatic Redirection**: Automatically redirect users to the destination URL based on the unique ID.\n\n## Requirements\n\n- Python: **3.10+**\n- Django: **4+**\n\n## Installation\n\n1. Install the package:\n\n```bash\npip install django-permalinker\n```\n\n2. Add `django_permalinker` to your `INSTALLED_APPS` in `settings.py`:\n\n```python\nINSTALLED_APPS = [\n    # Other apps\n    'django_permalinker',\n]\n```\n\n3. Include the `django_permalinker` URLs in your project’s `urls.py`:\n\n```python\nfrom django.urls import path, include\n\nurlpatterns = [\n    # Other paths\n    path(\"link/\", include(\"django_permalinker.urls\")),\n]\n```\n\n4. Run migrations to create the necessary database tables:\n\n```bash\npython manage.py migrate\n```\n\n5. Start the Django development server:\n\n```bash\npython manage.py runserver\n```\n\n## Configuration\n\nCustomize the behavior of permalink ID generation in your Django project’s `settings.py` file:\n\n- **PERMALINKER_ID_LENGTH**: Defines the length of the generated ID (default: 5).\n- **PERMALINKER_ID_INCLUDE_UPPERCASE**: If set to `True`, uppercase letters will be included in the ID (default: `True`).\n- **PERMALINKER_ID_INCLUDE_DIGITS**: If set to `True`, digits will be included in the ID (default: `True`).\n\nExample:\n\n```python\n# settings.py\n\nPERMALINKER_ID_LENGTH = 8  # Custom ID length\nPERMALINKER_ID_INCLUDE_UPPERCASE = False  # Only lowercase letters\nPERMALINKER_ID_INCLUDE_DIGITS = True  # Include digits\n```\n\n## Usage\n\n### Creating and Managing Links\n\n1. Access the **Django Admin** interface at `http://localhost:8000/admin/`.\n2. Navigate to the **Permalinker** section and manage your links:\n   - **Add New Link**: Create a new link with a destination URL, name, and description.\n   - **List Links**: View all the existing links.\n   - **Edit Existing Links**: Update or delete existing links.\n\n### Redirecting\n\nOnce a link is created, you can access the link's permanent URL by visiting:\n\n```\nhttp://localhost:8000/link/\u003clink_id\u003e/\n```\n\nDjango will handle the redirection to the destination URL automatically.\n\n## Example\n\n1. Create a new link in the admin panel:\n   - **Name**: `Example link`\n   - **Destination URL**: `https://example.com`\n   \n2. Access the permanent link:\n\n```\nhttp://localhost:8000/link/abc123/\n```\n\nYou will be redirected to `https://example.com`.\n\n## Screenshots\n\n### 1. Admin: List Links View\nView all the existing links in the Django admin.\n\n![](https://raw.githubusercontent.com/efficient-solutions/django-permalinker/0.1.0/img/admin-list-view.png)\n\n### 2. Admin: Add New Link View\nCreate a new link by providing a name, destination URL, and description.\n\n![](https://raw.githubusercontent.com/efficient-solutions/django-permalinker/0.1.0/img/admin-add-view.png)\n\n### 3. Admin: Edit Existing Link View\nEdit an existing link’s details or delete it.\n\n![](https://raw.githubusercontent.com/efficient-solutions/django-permalinker/0.1.0/img/admin-edit-view.png)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrei-demidov%2Fdjango-permalinker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandrei-demidov%2Fdjango-permalinker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrei-demidov%2Fdjango-permalinker/lists"}