standalorm

A Python library that enables you to harness the power of Django's ORM in standalone Python scripts.

Installation

$ pip install standalorm

Usage

Getting started with standalorm is quick and easy.

1. Create a Django app in your project's root directory:

   $ standalorm startapp
   

2. Create your models in app-directory/models.py:

   from django.db import models
   
   # For demonstration purposes only.
   class ExampleModel(models.Model):
       exampleField = models.Field()
   

3. Make and apply your migrations:

   $ standalorm makemigrations
   

   $ standalorm migrate
   

4. Import the orm_init() function into your code and call it with the dunder variable __file__ as its sole argument:

   from standalorm import orm_init
   
   orm_init(__file__)
   

5. Finally, import your models:

   # orm_init() must be imported AND called before this!
   
   from db import models  # Replace "db" with the name of your Django app if necessary
   
   # Do stuff with your models here
   

That's it.

This example doesn't demonstrate the full extent of standalorm's capabilities. You'll have to see the documentation for that.

Database Support

standalorm supports Oracle, PostgreSQL, and SQLite databases. A SQLite database connection comes configured for you, and standalorm will use it by default if you don't add a different one yourself. More on adding database connections can be found in the documentation.

Additional Notes

standalorm is intended for people who are already familiar with Django's ORM; as such, the basics of how to use the ORM are outside the scope of both this README and standalorm's documentation. If you're looking to familiarize yourself with Django's ORM, see Django's own documentation, particularly the sections on models and making queries.

Documentation

standalorm's full documentation can be found at https://standalorm.readthedocs.io.

Attributions

standalorm is based on Dan Caron's Django ORM Standalone Template.

"Django" is a registered trademark of the Django Software Foundation, which does not endorse this software.

License

standalorm is released under the MIT License.