>> Presentation :

cropped and compressed logo

The bulb package extends the Django framework to make it compatible with the Neo4j databases, and provides many more tools to deploy consequent websites. Two other solutions already exist to use Django with Neo4j, but they each have their own inconveniences :

neo4django neomodel
This package is out of date (last update in 2013). His usage is deprecated, because he runs under very old versions of all its components : Python 2.X / Django 1.5 / Neo4j 1.9. Furthermore, neo4django does not provide support for the Django's sessions nor a complete support for the Django's authentication, nor a support for the Django administration. This package is regularly updated, he runs also under the latest versions of all its components. He provides a very complete adaptation of Django's models, but the philosophy of these contributors is almost to make a 'ready and easy to use' tool, so the user interact only with the high-level surface. Such a reasoning leads to less freedom in what you want to do. This philosophy is perfect to deploy some small projects faster, it conduces to a total remake and to more complex programs, for when we'll want to do more precise operations or we will want to improve the performances of our project, with creation of a cluster, for example. Furthermore, neomodel does not provides support neither for Django's sessions, nor Django's authentication, or Django's administration.

bulb has a completely different philosophy. It offers you the choice to use "ready and easy to use" functions to code fatser or to let you interact with deeper concepts and to do exactly what you want to do. First, the database interactions have been developed to let the user use writing queries and reading queries, but also more advanced concepts like make multi-transactions sessions and causal chaining. On the other hand, methods have been developed to make easier the use of these concepts.

NB : The separation of writing and reading queries is the unique condition to set up clusters. So you could just use these two 'ready to use' methods and get pretty good results.

Then, and to lesser extent than neomodel, we have to rewrite Django's 'models' , to make them 'node_models'. bulb's node_models are a bit different than the original Django's models, but allows more flexibility.

Look at this comparison chart, and make the better choice for your needs :

 bulb  neomodel neo4django
Python 2.X support
Python 3.X support
Last Neo4j versions support
Last Django versions support
Ready and easy to use models
Highly customizable models
Relationship directly integrated to models
Independant and reusable relationship models
Highly customizable relationship models
Django's sessions support
Django's authentication support
Additional functionalities for authentication
Django's administration support
Highly customizable administration
Neo4j's clusters support
Neo4j's customizable sessions support
Neo4j's causal chaining support
Neo4j's geospacial operations support
Fully CDN integration
Automatic staticfiles compression
Automatic staticfiles compilation
Full SFTP support for staticfiles
Reinforcement of the password system
SASS/SCSS support
Webpack integration
Polyfill integration
Some front-end tools

To conclude, if you absolutely want the exact same models' structure as Django or if you have to make compatible an already existing project with Neo4j (and if you don't need neither sessions, nor authentication or administration), you should use neomodel. For the other cases, check this documentation :)

>> Installation