Neolith, for Django

Neolith is an open source specification and Django library for running a Django app inside a shared process or as its own service, and moving it between the two by configuration, with no change to its code. Deploy Django apps, not Django projects.

A Django app attached to a project and the same app detached into its own service call each other the same way, through contracts, and the difference is configuration, not code. Neolith is defined by a specification that is independent of Django and Python, and django-neolith is its reference implementation. The code is open source under the BSD-3-Clause license.

Pre-alpha: nothing is installable yet

There are no releases. The specification is draft 0.1 and nothing in it is stable until django-neolith 0.1 ships against it. These docs describe where the project is, not a product you can install or run in production today. To follow along, read the specification and the roadmap.

Where to start

SpecificationThe contracts, transports, HTTP transport, app declaration and conformance rules, with requirement IDs.

Decision recordsWhy each significant choice was made: context, options, decision and consequences.

Roadmap to 0.1The eight steps to the first release and what each delivers.

Vision and principlesWhat Neolith is for, and the principles written as X over Y.

TutorialNot written yet. There is nothing to install.

How-to guidesNot written yet. Guides follow the first release.

ReferenceImplementation notes. API reference follows the first release.

ContributingHow to propose a change, the test rules and the review process.

Source: github.com/stack314/django-neolith. The Neolith project page is at stack314.com/neolith.