Metadata-Version: 2.1
Name: cslab-xadmin
Version: 3.0.6
Summary: Optimized xadmin fork for Django 3.0, maintained by OBR CSLAB team.
Home-page: https://github.com/reggiepy/cslab-xadmin
Download-URL: https://github.com/reggiepy/cslab-xadmin/archive/master.zip
Author: OBR CSLAB
Author-email: sshwsfc@gmail.com
License: Copyright (c) Django Xadmin and individual contributors.
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without modification,
        are permitted provided that the following conditions are met:
        
            1. Redistributions of source code must retain the above copyright notice, 
               this list of conditions and the following disclaimer.
            
            2. Redistributions in binary form must reproduce the above copyright 
               notice, this list of conditions and the following disclaimer in the
               documentation and/or other materials provided with the distribution.
        
            3. Neither the name of Django Xadmin nor the names of its contributors may be used
               to endorse or promote products derived from this software without
               specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
        ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
        (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
        LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
        ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
        SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Keywords: admin,django,xadmin,bootstrap
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: setuptools
Requires-Dist: django<4.0,>=3.0
Requires-Dist: django-crispy-forms>=1.12.0
Requires-Dist: django-reversion>=3.0.0
Requires-Dist: django-formtools>=2.3
Requires-Dist: django-import-export>=2.5.0
Requires-Dist: httplib2>=0.9.2
Requires-Dist: future
Requires-Dist: six
Provides-Extra: excel
Requires-Dist: xlwt; extra == "excel"
Requires-Dist: xlsxwriter; extra == "excel"
Provides-Extra: reversion
Requires-Dist: django-reversion>=3.0.0; extra == "reversion"

# cslab-xadmin (OBR CSLAB Django 3 Fork)

**cslab-xadmin** is a drop-in replacement of Django admin for **Django 3.0/3.2**, maintained by the OBR CSLAB team.

It is fully extensible with plugin support and features a pretty UI based on Twitter Bootstrap 3.

## Key Features

- **Django 3.0+ Ready**: Fully compatible with Django 3.0 and 3.2 LTS.
- **Modern Python**: Optimized for Python 3.6 - 3.10.
- **Built-in Plugins**: Includes export, import, charts, dashboard, and more.
- **Bootstrap 3**: Clean and responsive user interface based on Twitter Bootstrap with theme support.
- **Better UX**: Enhanced filters, date ranges, number ranges, and in-site bookmarking.

## Quick Start

### Install

Installation via PyPI:

```bash
pip install cslab-xadmin
```

Or install from source:

```bash
pip install git+https://github.com/reggiepy/cslab-xadmin.git
```

### Install Requires

- [django](http://djangoproject.com) >=3.0, <4.0
- [django-crispy-forms](http://django-crispy-forms.rtfd.org) >=1.12.0
- [django-import-export](https://github.com/django-import-export/django-import-export) >=2.5.0
- [django-reversion](https://github.com/etianen/django-reversion) >=3.0.0
- [django-formtools](https://github.com/django/django-formtools) >=2.3
- [six](https://github.com/benjaminp/six)

## Usage

Add `xadmin` and `crispy_forms` to your `INSTALLED_APPS`:

```python
INSTALLED_APPS = (
    ...
    'xadmin',
    'crispy_forms',
    'reversion', # optional
)
```

And replace the default `admin.site.urls` in your `urls.py`:

```python
import xadmin
xadmin.autodiscover()

from xadmin.plugins import xversion
xversion.register_models()

urlpatterns = [
    path(r'xadmin/', xadmin.site.urls),
]
```

## Run Demo Locally

```bash
cd demo_app
python manage.py migrate
python manage.py runserver
```

Open http://127.0.0.1:8000 in your browser, the admin user password is `admin`.

## License

BSD License. See the LICENSE file for details.
