Skip to content

maykinmedia/objects-api-client-django

Repository files navigation

Objects API Client (for Django)

Version:0.4.1
Source:https://github.com/maykinmedia/objects-api-client-django
Keywords:Objects API, Client, Django
PythonVersion:3.11

Build status Supported Python versions Supported Django versions Latest version on PyPI

About

Easily integrate Objects API in your Django application.

Installation

Requirements

  • Python 3.11 or newer
  • Django 4.2 or newer

Install

You can the install Objects API Client either via the Python Package Index (PyPI) or from source.

To install using pip:

pip install objects-api-client-django

Usage

To use this with your project you need to follow these steps:

  1. Add objectsapiclient to INSTALLED_APPS in your Django project's settings.py:

    INSTALLED_APPS = (
        # ...,
        "objectsapiclient",
    )
  2. Configure your Objects API connection and settings in the admin, under Objects API client configuration.

  3. Done.

Development

Install dependencies for development:

pip install -e .[tests,release]

Running tests:

# Run all tests
pytest tests/

# Run all checks (tests for all Python/Django combinations + linting)
tox

Linting and formatting:

# Check code quality
ruff check .

# Auto-fix issues
ruff check --fix .

# Format code
ruff format .

# Run via tox
tox -e ruff

Licence

Copyright © Maykin Media B.V., 2025

Licensed under the MIT.

About

A Django app to integrate with the Objects API

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •