python-arango-ogm 0.1.8

Python-based package implementing an OGM framework for arango; built on top of python-arango.

Python Arango OGM

Python-based package implementing an OGM framework for arango; built on top of python-arango.

GitHub

https://github.com/tangledpath/python-arango-ogm

Documentation

https://tangledpath.github.io/python-arango-ogm/python_arango_ogm.html

Installation

pip install python-arango-ogm

Getting started

Create a .env file at the root of your repository with the following keys; values to be adjusted for your application:

PAO_MODELS=yourapp.db.models
PAO_GRAPH_NAME=yourapp
PAO_DB_NAME=yourapp
PAO_DB_HOST=localhost
PAO_DB_PORT=8529
PAO_DB_ROOT_USER=root
PAO_DB_ROOT_PASS=<ARANGO_ROOT_PASSWORD>
PAO_DB_USER=yourapp 
PAO_DB_PASS=<ARANGO_yourapp_PASSWORD>
PAO_APP_PACKAGE=yourapp.db

In this setup, there should be a models.py in the yourapp.db package. For example:

from python_arango_ogm.db import pao_model


class FooModel(pao_model.PAOModel):
    field_int = pao_model.IntField(index_name='field_int_idx')
    field_str = pao_model.StrField(unique=True, index_name='field_str_idx')
    bar_edge = pao_model.EdgeTo("BarModel")


class BarModel(pao_model.PAOModel):
    field_int = pao_model.IntField(index_name='field_int_idx', required=True)
    field_str = pao_model.StrField(unique=True, index_name='field_str_idx')


class BazModel(pao_model.PAOModel):
    field_int = pao_model.IntField(index_name='field_int_idx', unique=True, required=True)
    field_str = pao_model.StrField(index_name='field_str_idx')
    foo_edge = pao_model.EdgeTo(FooModel)

Usage:

pao-migrate CLI

• Make uncreated migrations for models: pao-migrate make-migrations
• Migrate the database: pao-migrate migrate
• Remove and Migrate the database: pao-migrate migrate --clean
• List migrations: pao-migrate list-migrations
• Rollback last migration: pao-migrate migrate-rollback
• Create a blank migration: pao-migrate new-migration <MIGRATION_NAME>
• To see help pao-migrate --help
• To see help for a specific command, for example: pao-migrate migrate --help

In code

You may use your models to perform various queries and commands TODO: document this more

Development

Linting

   ruff check . # Find linting errors
   ruff check . --fix # Auto-fix linting errors (where possible)

Documentation

  # Shows in browser
  poetry run pdoc python_arango_ogm
  # Generates to ./docs
  poetry run pdoc python_arango_ogm -o ./docs

Testing

  clear; pytest

Building and Publishing

Building

poetry build

Publishing

Note: --build flag build before publishing poetry publish --build -u __token__ -p $PYPI_TOKEN