django-filip 0.1.4

Exchanging data between different systems

Django-Filip

Background

django-filip is a light-weight integration layer for use with Django. It allows you to easily connect to different kinds of servers, using API, MSSQL and SFTP.

django-filip is currently in early development, and breaking changes may happen at any time. Make sure to pin your exact version!

Quickstart

Installing with uv

uv add django-filip

Add to installed apps

# settings.py

INSTALLED_APPS = [
    ...
    'django-filip',
    ...

Make sure to do database migrations:

uv run manage.py migrate

Usage examples

Set up connections in Django-Admin

API Request

from django_filip.models import Connection

connection = Connection.objects.get(id=1)
response = connection.client.get('v1/objects/suppliers?param=1')
items = response.json()

Database Query

from django_filip.models import Connection

connection = Connection.objects.get(id=1)
query = 'SELECT * FROM suppliers'
results = connection.client.execute_query(query)

SFTP Upload

from django_filip.models import Connection

connection = Connection.objects.get(id=1)
with document.file.open('rb') as file:
    response = connection.client.upload(file, '/remote/path', 'document.pdf')

For more examples, see examples.md

Compatibility

This app is designed and tested to work with the Django LTS versions:

• Django 5.2.x

Other versions (ex. 5.0.x, 5.1.x) are not officially supported. Make sure to lock in on an LTS-version in 'pyproject.toml':

For Django 5.2.x:

dependencies = ["django>=5.2,<5.3"]