directus-sdk-py 1.0.0

Python SDK for interacting with Directus API (colletion, items, users, files)

Directus Python SDK

A Python SDK for interacting with Directus, an open-source headless CMS and API platform.

About Directus

Directus is a powerful and flexible open-source headless CMS and API platform. It provides a user-friendly interface for managing content and a robust API for integrating with other applications. Directus allows you to create and customize your data models, manage users and permissions, and easily expose your data through a RESTful API.

About the library

This library provides a Python SDK for interacting with Directus. You can use it to perform various operations such as managing users, files, collections, and items. The SDK simplifies the process of interacting with the Directus API by providing a set of methods that you can use to perform common tasks.

Installation

You can install the Directus Python SDK using pip:

pip install directus-sdk-py

Usage

Here are some examples of how to use the Directus Python SDK:

Initialize the Client

from directus_sdk_py import DirectusClient

client = DirectusClient(url='https://your-directus-instance.com', token='your_access_token')

Authentication

# Login with email and password
client.login(email='[e-mail]', password='password')

# Logout
client.logout()

Users Management

# Get all users
users = client.get_users()

# Create a new user
user_data = {
    'first_name': 'John',
    'last_name': 'Doe',
    'email': '[e-mail]',
    'password': 'password'
}
new_user = client.create_user(user_data)

# Update a user
updated_user = client.update_user(user_id='user_id', user_data={'first_name': 'Updated Name'})

# Delete a user
client.delete_user(user_id='user_id')

Files Management

# Get all files
files = client.get_files()

# Search files with a filter
request = {
    "query": {
        "filter": {
            "title": {
                "_icontains": "my search request" # Search for files with "my search request" in the title
            }
        }
    }
}
items = client.get_files(request)


# Suppose you get an item and it's a photo, you can get the URL of the photo with the following code
photo_url = client.get_file_url(items[0]['id'])

# It's possible to transform or add some display options to the photo URL
display = {
    "quality": 95, # Quality of the image
}
transform = [
    ["blur", 10], # Blur the image
    ["tint", "rgb(255, 0, 0)"] # Tint the image in red
]

photo_url = client.get_file_url(items[0]['id'], display=display, transform=transform)

# Download the file on the disk
client.download_file(items[0]['id'], 'path/to/download.jpg', display=display, transform=transform)


# Upload a file
data = {
    "title": "Readme",
    "description": "Readme file",
    "tags": ['readme', 'file'],
}
file = client.upload_file("readme.md", data)

# Delete a file
client.delete_file(file_id='file_id')

Information about filter requests can be found in the Directus API documentation

Collection and Item Management

# Get a collection
collection = client.get_collection(collection_name='your_collection')

# List all items and filter the results
collection = "my_collection"
request = {
    "query": {
        # More information about filter requests can be found in the Directus API documentation (https://docs.directus.io/reference/filter-rules.html)
        "filter": {
            "col_name": {
                "_icontains": "inverness" # Search inverness in the col_name column 
            }
        }
    }
}
items = client.get_items(collection, request)


# Get an item from a collection
item = client.get_item(collection_name='your_collection', item_id='item_id')

# Create a new item in a collection
item_data = {
    'title': 'New Item',
    'description': 'This is a new item'
}
new_item = client.create_item(collection_name='your_collection', item_data=item_data)

# Update an item in a collection
updated_item = client.update_item(collection_name='your_collection', item_id='item_id',
                                  item_data={'title': 'Updated Title'})

# Delete an item from a collection
client.delete_item(collection_name='your_collection', item_id='item_id')

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.

Acknowledgements

This library was inspired by the directus-sdk-python project, which is also released under the MIT License. Special thanks to the contributors of that project for their work.