https://github.com/nitely/spirit

Spirit is a modern Python/Django forum
https://github.com/nitely/spirit

django django-framework forum python spirit

Last synced: 27 days ago
JSON representation

Spirit is a modern Python/Django forum

• Host: GitHub
• URL: https://github.com/nitely/spirit
• Owner: nitely
• License: mit
• Created: 2014-05-09T21:31:33.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2025-02-25T21:14:47.000Z (2 months ago)
• Last Synced: 2025-04-14T01:08:50.385Z (27 days ago)
• Topics: django, django-framework, forum, python, spirit
• Language: Python
• Homepage: http://spirit.readthedocs.io
• Size: 11.7 MB
• Stars: 1,178
• Watchers: 49
• Forks: 332
• Open Issues: 38
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

        
# 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