Metadata-Version: 2.1
Name: acdh-django-browsing
Version: 3.0
Summary: Django-App providing some useful things to create browsing views
Author-email: Peter Andorfer <peter.andorfer@oeaw.ac.at>
Project-URL: Homepage, https://github.com/acdh-oeaw/acdh-django-browsing
Keywords: django
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: django-crispy-forms
Requires-Dist: django-filter
Requires-Dist: django-super-deduper
Requires-Dist: django-tables2
Requires-Dist: tablib
Provides-Extra: build
Requires-Dist: build ; extra == 'build'
Provides-Extra: linting
Requires-Dist: flake8 ; extra == 'linting'
Provides-Extra: tests
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: coverage ; extra == 'tests'

[![flake8 Lint](https://github.com/acdh-oeaw/acdh-django-browsing/actions/workflows/lint.yml/badge.svg)](https://github.com/acdh-oeaw/acdh-django-browsing/actions/workflows/lint.yml)
[![Test](https://github.com/acdh-oeaw/acdh-django-browsing/actions/workflows/test.yml/badge.svg)](https://github.com/acdh-oeaw/acdh-django-browsing/actions/workflows/test.yml)

# acdh-django-browsing

Django-App providing some useful things to create browsing views

## Quickstart

Install acdh-django-browsing:

`pip install acdh-django-browsing`

Add it to your `INSTALLED_APPS`:

```python
INSTALLED_APPS = (
    ...
    'browsing',
    ...
)
```


## Develop

### install dev-dependencies
```bash
pip install build pytest coverage flake8 black django django-next-prev
```

### install package
```bash
pip install .
```

### run migrations and start dev server
```
python manage.py migrate
python manage.py runserver
```

### build the package

```
python -m build
```
