Metadata-Version: 2.1
Name: django-admin-column-toggle
Version: 0.1.0
Summary: A reusable Django package to add column toggle functionality in the Django admin interface.
Home-page: https://github.com/engwerda/Django-Admin-Column-Toggle
License: MIT
Keywords: django
Author: Simon Engwerda
Author-email: simon@engwerda.net
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
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-Dist: django (>=3.2,<5.0)
Project-URL: Repository, https://github.com/engwerda/Django-Admin-Column-Toggle
Description-Content-Type: text/markdown

# Django Admin Column Toggle

Django Admin Column Toggle is a reusable Django package that adds column toggle functionality to the Django admin interface. This allows users to show or hide columns in the list view of the Django admin site.

## Installation

1. Install the package:

   With poetry
   ```
   poetry add django-admin-column-toggle
   ```
   With pip
   ```
   pip install django-admin-column-toggle
   ```

2. Add 'column_toggle' to your `INSTALLED_APPS` setting in your Django project:

   ```python
   INSTALLED_APPS = [
   ...
   'column_toggle',
   ]
   ```

## Usage

1. Import `ColumnToggleModelAdmin` from `column_toggle.admin` and inherit it in your `ModelAdmin` class. For example:

   ```python
   from django.contrib import admin
   from column_toggle.admin import ColumnToggleModelAdmin
   from .models import YourModel

   @admin.register(YourModel)
   class YourModelAdmin(ColumnToggleModelAdmin):
   list_display = ('field1', 'field2', 'field3')
   ```

2. That's it! Now you should have column toggle functionality in the Django admin list view for the specified model.

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT](https://choosealicense.com/licenses/mit/)

