Library Mode#

Using Construbot as a Django app within your own project.

Overview#

Construbot can run in two modes:

Standalone Mode (default) - Full application with admin, accounts, authentication
Library Mode - Django app embedded in your project

Enable library mode:

CONSTRUBOT_AS_LIBRARY=True

What Changes#

When CONSTRUBOT_AS_LIBRARY=True:

❌ Disabled:

Django admin interface
allauth URLs (account management)
Standalone authentication views
Account configuration app

✅ Still Available:

Core business models (Contrato, Estimate, etc.)
API endpoints
Business logic and views (if you include URLs)
Template tags and utilities

Use Cases#

When to use library mode:

Integrating Construbot into existing Django project
Using your own authentication system
Customizing admin interface
Building custom frontend

When NOT to use:

Need complete standalone solution
Want built-in authentication
Using out-of-the-box

Setup#

1. Install package:

pip install construbot  # When available on PyPI

# Or from source:
pip install git+https://github.com/javier-llamas/construbot.git

2. Add to INSTALLED_APPS:

INSTALLED_APPS = [
    # Your apps
    'myapp',

    # Add Construbot apps
    'construbot.users',
    'construbot.proyectos',
    'construbot.core',
    'construbot.api',

    # Django apps
    'django.contrib.admin',
    ...
]

3. Set library mode:

# In .env
CONSTRUBOT_AS_LIBRARY=True

4. Include URLs (optional):

# urls.py
urlpatterns = [
    path('construbot/', include('construbot.proyectos.urls')),
    path('api/v1/', include('construbot.api.urls')),
]

5. Run migrations:

python manage.py migrate

Configuration#

Settings:

# settings.py

# Use Construbot's custom user model (recommended)
AUTH_USER_MODEL = 'users.User'

# Or map to your own user model
# (requires custom integration)

# Database
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        ...
    }
}

# Library mode
CONSTRUBOT_AS_LIBRARY = True

Integration Patterns#

Using Construbot Models#

from construbot.proyectos.models import Contrato, Contraparte
from construbot.users.models import Company

# Create company
company = Company.objects.create(
    customer=my_customer,
    nombre="My Company"
)

# Create contract
contract = Contrato.objects.create(
    company=company,
    folio="C-001",
    ...
)

Custom Authentication#

# If not using Construbot's User model:
# Map your users to Construbot companies

from construbot.users.models import Company, UserCompany

# Associate your user with Construbot company
UserCompany.objects.create(
    user=my_user,  # Your user model
    company=construbot_company
)

API Only#

# Use only Construbot's API, not web interface

INSTALLED_APPS = [
    'construbot.users',
    'construbot.proyectos',
    'construbot.api',
    'rest_framework',
    'rest_framework_simplejwt',
]

urlpatterns = [
    path('api/v1/', include('construbot.api.urls')),
]

Limitations#

In library mode:

No built-in admin interface (use Django admin or build your own)
No user registration/login views (implement your own)
Manual setup required for permissions
Need to handle company switching yourself

Troubleshooting#

“No module named construbot”:

Ensure Construbot is installed:

pip show construbot

“Table doesn’t exist”:

Run migrations:

python manage.py migrate

“AUTH_USER_MODEL conflicts”:

Choose one:

Use Construbot’s User model: AUTH_USER_MODEL = 'users.User'
Create custom integration between your User and Construbot models

Example Project#

# settings.py
INSTALLED_APPS = [
    'myapp',
    'construbot.users',
    'construbot.proyectos',
    'construbot.core',
    'django.contrib.admin',
    ...
]

AUTH_USER_MODEL = 'users.User'
CONSTRUBOT_AS_LIBRARY = True

# urls.py
urlpatterns = [
    path('admin/', admin.site.urls),
    path('construbot/', include('construbot.proyectos.urls')),
    path('api/', include('construbot.api.urls')),
]

# views.py
from construbot.proyectos.models import Contrato

def my_view(request):
    contracts = Contrato.objects.filter(
        company=request.user.active_company
    )
    return render(request, 'my_template.html', {'contracts': contracts})