Metadata-Version: 2.4
Name: django-content-studio
Version: 1.11.0
Summary: A modern Django admin alternative, batteries included
License-Expression: MIT
License-File: LICENSE
Keywords: django,django-admin,admin,admin-interface,content-management,react
Author: Leon van der Grient
Author-email: leon@dwarsbit.nl
Requires-Python: >=3.12
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 5.2
Classifier: Framework :: Django :: 6.0
Classifier: Framework :: Django :: 6.1
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Provides-Extra: excel
Provides-Extra: huey
Provides-Extra: images
Requires-Dist: Django (>=5.2,<7)
Requires-Dist: djangorestframework (>=3.17.2,<4)
Requires-Dist: huey[stats] (>=3.5,<4) ; extra == "huey"
Requires-Dist: jsonschema (>=4.26.0,<5.0.0)
Requires-Dist: nh3 (>=0.3.0,<1.0.0)
Requires-Dist: openpyxl (>=3.1,<4) ; extra == "excel"
Requires-Dist: packaging (>=23)
Requires-Dist: pick (>=2.5,<3)
Requires-Dist: pillow (>=10) ; extra == "images"
Requires-Dist: pyjwt (>=2,<3)
Requires-Dist: rich (>=14.3.3,<15)
Project-URL: Changelog, https://github.com/dwarsbit/django-content-studio/blob/main/CHANGELOG.md
Project-URL: Documentation, https://djangocontentstudio.org/docs/intro
Project-URL: Homepage, https://djangocontentstudio.org/
Project-URL: Issues, https://github.com/dwarsbit/django-content-studio/issues
Project-URL: Repository, https://github.com/dwarsbit/django-content-studio
Description-Content-Type: text/markdown

<p align="center">
  <img src="https://raw.githubusercontent.com/dwarsbit/django-content-studio/main/website/static/img/logo.svg" alt="Django Content Studio" width="96">
</p>

<h1 align="center">Django Content Studio</h1>

<p align="center">
  <a href="https://badge.fury.io/py/django-content-studio"><img src="https://badge.fury.io/py/django-content-studio.svg" alt="PyPI version"></a>
  <a href="https://pypi.org/project/django-content-studio/"><img src="https://img.shields.io/pypi/pyversions/django-content-studio.svg" alt="Python versions"></a>
  <a href="https://pypi.org/project/django-content-studio/"><img src="https://img.shields.io/pypi/frameworkversions/django/django-content-studio.svg" alt="Django versions"></a>
  <a href="https://github.com/dwarsbit/django-content-studio/actions/workflows/ci.yml"><img src="https://github.com/dwarsbit/django-content-studio/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg" alt="License"></a>
</p>

Django Content Studio is a modern alternative to the classic Django admin.
Register the models you already have and manage them in an admin with list
pages, edit pages, a dashboard and a media library. Optional fields and
models help with content-driven projects.

<p align="center"><strong>Documentation: <a href="https://djangocontentstudio.org/">djangocontentstudio.org</a></strong></p>

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/dwarsbit/django-content-studio/main/website/static/img/screenshots/dashboard-dark.webp">
  <img src="https://raw.githubusercontent.com/dwarsbit/django-content-studio/main/website/static/img/screenshots/dashboard-light.webp" alt="The Content Studio dashboard with statistics, content lists and recent activity">
</picture>

## Features

- **Your models, as they are**: register a plain Django model, as in the
  classic Django admin. There is nothing to migrate to.
- **List pages** with search, filters, sorting, bulk actions, a trash and
  export.
- **Edit pages laid out in Python**, with widgets for dates, rich text,
  tags, colors, media and structured JSON, block fields, and text
  components.
- **A dashboard** with statistics, content lists, recent activity and
  background tasks.
- **A media library** with folders, uploads, crops, focal points and image
  sizes.
- **Collaboration**: notifications, presence avatars and a command palette.
- **Access control** that follows the permission hooks of the classic
  Django admin, down to single objects.
- **Multi-tenancy**: one method decides which tenants an editor may work in.
- **Extensions, webhooks and built-in fields and models** such as
  `HTMLField`, `ColorField` and `ContentModel`, all optional.

Content Studio does not render your website. It manages content, the way
the classic Django admin does.

## Requirements

- Python 3.12 or later
- Django 5.2, 6.0 or 6.1

## Quick start

1. Install the package:

   ```bash
   pip install django-content-studio
   ```

2. Add the apps to your settings:

   ```python
   # mysite/settings.py
   INSTALLED_APPS = [
       "django.contrib.admin",
       "django.contrib.auth",
       "django.contrib.contenttypes",
       "django.contrib.sessions",
       "django.contrib.messages",
       "django.contrib.staticfiles",
       "rest_framework",
       "content_studio",
       "blog",
   ]
   ```

3. Mount the admin:

   ```python
   # mysite/urls.py
   from django.urls import include, path

   urlpatterns = [
       path("admin/", include("content_studio.urls")),
   ]
   ```

4. Register one of your models in your app's `admin.py`. The example uses
   an `Article` model with a `title` and a `status` field:

   ```python
   # blog/admin.py
   from content_studio import register
   from content_studio.admin import ModelStudio

   from .models import Article


   @register(Article)
   class ArticleStudio(ModelStudio):
       table_display = ["title", "status"]
       list_filter = ["status"]
       search_fields = ["title"]
   ```

5. Start the development server, open `/admin/` and log in with a staff
   account.

Continue with [Getting started](https://djangocontentstudio.org/docs/getting-started)
in the documentation.

## Documentation

The full documentation is at [djangocontentstudio.org](https://djangocontentstudio.org/).
Good places to start:

- [Introduction](https://djangocontentstudio.org/docs/intro): what Content Studio is, and what it is not
- [Getting started](https://djangocontentstudio.org/docs/getting-started): installation and your first model
- [Registering models](https://djangocontentstudio.org/docs/registering-models): studio options, singletons and inlines
- [Edit page layout](https://djangocontentstudio.org/docs/edit-page): form sets, the sidebar and components
- [Access control](https://djangocontentstudio.org/docs/permissions): model and object permissions
- [Deployment](https://djangocontentstudio.org/docs/deployment): a deployment checklist and system checks
- [How it compares](https://djangocontentstudio.org/docs/comparison): Content Studio next to admin themes and content management systems

See also [Django Headless](https://djangoheadless.org), if you need an API
for your own clients.

## Contributing and support

- Read [CONTRIBUTING.md](CONTRIBUTING.md) to set up the project and propose a change.
- Report bugs in [GitHub Issues](https://github.com/dwarsbit/django-content-studio/issues) and ask questions in [GitHub Discussions](https://github.com/dwarsbit/django-content-studio/discussions).
- Report security problems privately; see [SECURITY.md](SECURITY.md).

## License

MIT; see [LICENSE](LICENSE). Changes are listed in the [changelog](CHANGELOG.md).

