Skip to content

nitely/Spirit

Repository files navigation

Spirit

Build Status Coverage Status pypi licence

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

Documentation

Docs can be found at spirit.readthedocs.io

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?"

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

For detailed setup docs, see spirit.readthedocs.io

Dev

Use uv tooling.

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