Metadata-Version: 2.4
Name: django-cs-robots
Version: 0.1.3
Summary: A django app to change robots.txt from the admin panel without using the database.
Author-email: Jatsu Argarate <jargarae@codesyntax.com>
Project-URL: Homepage, https://github.com/jatsu/django-admin-robots
Project-URL: Issues, https://github.com/jatsu/django-admin-robots/issues
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Framework :: Django :: 4.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: Django>=3.2


# Django CS Robots

A simple, database-free Django app to manage your robots.txt file directly from the admin interface.

This package provides a straightforward solution for allowing site administrators to edit the robots.txt file without developer intervention. Instead of storing the content in a database model, this app reads from and writes directly to a physical     file on your server. The file's path is fully configurable in your project's settings.py.

Key Features

    Edit in the Admin: Provides a simple and intuitive form within the Django admin to modify your robots.txt content.

    Database-Free: Directly reads from and writes to a file on the filesystem, avoiding database overhead and migrations.

    Configurable Path: You can specify the exact location of your robots.txt file in your settings.py for full control.

    Dynamic Serving: Includes a view that serves the robots.txt file dynamically, ensuring that any changes made in the admin are live immediately.

    Easy Integration: Designed to be a plug-and-play addition to any Django project.

# Installation & Setup

Install the package from PyPI:

    pip install django-cs-robots

# settings.py
Add the app to your INSTALLED_APPS in settings.py. For the admin index page link to appear, place 'cs_robots' before 'django.contrib.admin'.
Python

    INSTALLED_APPS = [
        'cs_robots',
        'django.contrib.admin',
        # ... other apps
    ]


Define the absolute path to your robots.txt file

    ROBOTS_TXT_PATH = os.path.join(BASE_DIR, 'static', 'robots.txt')


# your_project/urls.py
    from django.contrib import admin
    from django.urls import path, include
    from cs_robots.views import serve_robots_txt # Import the serving view

    urlpatterns = [
        path('admin/', admin.site.urls),
    
        # Add the URL for the admin editor
        path('admin/tools/', include('cs_robots.urls')),
    
        # Add the URL to serve the robots.txt file publicly
        path('robots.txt', serve_robots_txt, name='robots_txt'),
    
        # ... other project urls
    ]
