Getting Started

This is the official documentation of the forestadmin-agent-django and forestadmin-agent-flask Python agents.

After doing the quick start, you should have a development project which is up and running and connected to your main data storage system.

However, you can plug as many data sources as you want into the same agent.

What can I connect to?

Forest Admin collections map to any of those concepts:

• ORM models

• Endpoints on SaaS providers (by writing a custom data source)

• Endpoints on your own API (by writing a custom data source)

Example

Flask / SQLAlchemy

In this example, we import collections from SQLAlchemy ORM.

Alone SQLAlchmy

from flask import Flask
from sqlalchemy.orm import declarative_base
from forestadmin.flask_agent.agent import create_agent
from forestadmin.datasource_sqlalchemy.datasource import SqlAlchemyDatasource

app = Flask(__name__)
Base = declarative_base(engine)

# ...

agent = create_agent(app)
# db_uri parameter is optional, but if the agent can't find
# an engine in your Base class you have to set it
agent.add_datasource(SqlAlchemyDatasource(Base, db_uri='sqlite:///path/to/db.sql'))

With Flask-SQLAlchemy package

from flask_sqlalchemy import SQLAlchemy
from flask import Flask
from forestadmin.flask_agent.agent import create_agent
from forestadmin.datasource_sqlalchemy.datasource import SqlAlchemyDatasource

app = Flask(__name__)
db = SQLAlchemy()

# ...

agent = create_agent(app)
# with app_context you don't have to specify the db_uri parameter
with app.app_context():
    # db.init_app(app)
    agent.add_datasource(SqlAlchemyDatasource(db))

Django

With the Django agent, the Django datasource is automatically added. If you prefer to add the datasource manually you have to:

• In project/settings.py set FOREST_AUTO_ADD_DJANGO_DATASOURCE = False to not auto add it

• Add a customization function

• Reference the customization function in project/settings.py

• Add the datasource in the customization function FOREST_CUSTOMIZE_FUNCTION="path.to.custom.function"

project/settings.py

FOREST_AUTO_ADD_DJANGO_DATASOURCE = False
FOREST_CUSTOMIZE_FUNCTION = "my_app.forest_admin.customize_forest"
# you can also directly pass a function
from my_app.forest_admin import customize_forest
FOREST_CUSTOMIZE_FUNCTION = customize_forest

my_app/forest_admin.py

from forestadmin.django_agent.agent import DjangoAgent
from forestadmin.datasource_django.datasource import DjangoDatasource

def customize_forest(agent: DjangoAgent):
    agent.add_datasource(DjangoDatasource())