Metadata-Version: 2.2
Name: django-spirit
Version: 0.14.2
Summary: Spirit is a Python based forum powered by Django.
Author-email: Esteban Castro Borsani <ecastroborsani@gmail.com>
License: MIT License
Project-URL: Documentation, https://spirit.readthedocs.io
Project-URL: Source, https://github.com/nitely/Spirit
Project-URL: Donate, https://ko-fi.com/nitely_
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
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: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: Django<5,>=4.2
Requires-Dist: django-haystack~=3.3
Requires-Dist: whoosh==2.7.4
Requires-Dist: mistune==0.8.4
Requires-Dist: Pillow>=11
Requires-Dist: olefile==0.47
Requires-Dist: django-infinite-scroll-pagination~=1.3
Requires-Dist: django-djconfig~=0.11
Requires-Dist: tzdata
Provides-Extra: files
Requires-Dist: python-magic==0.4.27; extra == "files"
Requires-Dist: python-magic-bin==0.4.14; sys_platform == "win32" and extra == "files"
Provides-Extra: huey
Requires-Dist: huey~=2.5; extra == "huey"
Provides-Extra: celery
Requires-Dist: celery[redis]~=5.4; extra == "celery"

# Spirit

[![Build Status](https://img.shields.io/github/actions/workflow/status/nitely/Spirit/ci.yml?branch=master&style=flat-square)](https://github.com/nitely/Spirit/actions?query=workflow%3ACI)
[![Coverage Status](https://img.shields.io/coveralls/nitely/Spirit/master.svg?style=flat-square)](https://coveralls.io/r/nitely/Spirit)
[![pypi](https://img.shields.io/pypi/v/django-spirit.svg?style=flat-square)](https://pypi.python.org/pypi/django-spirit)
[![licence](https://img.shields.io/pypi/l/django-spirit.svg?style=flat-square)](https://raw.githubusercontent.com/nitely/Spirit/master/LICENSE)

Spirit is a Python based forum built using the Django framework.

## Documentation

Docs can be found at [spirit.readthedocs.io](http://spirit.readthedocs.io/en/latest/)

## Compatibility

* Python 3.9, 3.10, 3.11, and 3.12
* Django 4.2 LTS
* PostgreSQL (recommended), MySQL, Oracle Database and SQLite

Constrained by "[What Python version can I use with Django?](https://docs.djangoproject.com/en/dev/faq/install/#what-python-version-can-i-use-with-django)"

## Usage

```
pip install django-spirit
spirit startproject mysite
cd mysite
python manage.py spiritinstall
python manage.py createsuperuser
python manage.py runserver
```

Visit [http://127.0.0.1:8000](http://127.0.0.1:8000)

For detailed setup docs, see [spirit.readthedocs.io](http://spirit.readthedocs.io/en/latest/)

## Dev

Use [uv tooling](https://docs.astral.sh/uv/).

### Testing

```
uv sync --all-extras
uv run spirit startproject test_project
uv run runtests.py
```

### Lint & Format

```
uvx ruff check --select I --fix
uvx ruff format
```

## License

MIT
