django-connectwise

Django app for working with ConnectWise. Defines models (tickets, members, companies, etc.) and callbacks.

Requirements

Python 3.12, 3.13 or 3.14
Django 4.2, 5.2 or 6.0

Other versions may work; we haven't tried. Django 4.2 is only tested on Python 3.12, since that's the newest Python it supports.

The models define GinIndexes on their user-defined-field data, so PostgreSQL is the expected database backend.

Installation

From PyPI:

pip install django-connectwise

From source:

git clone git@github.com:KerkhoffTechnologies/django-connectwise.git
cd django-connectwise
pip install -e .

Usage

Add to INSTALLED_APPS

INSTALLED_APPS = [
    ...
    'djconnectwise',
    'django.contrib.postgres',  # Required by the models' GinIndexes.
    ...
]

Add to urls.py:

re_path(
    r'^callback/',  # This can be whatever you want.
    include('djconnectwise.urls', namespace='connectwise')
),

Add to settings:

CONNECTWISE_SERVER_URL = 'https://connectwise.example.com'
CONNECTWISE_CREDENTIALS = {
    'company_id': 'your company ID',
    'api_public_key': 'your API user public key',
    'api_private_key': 'your API user private key',
}
CONNECTWISE_TICKET_PATH = 'v4_6_release/services/system_io/router/openrecord.rails'
def djconnectwise_configuration():
    return {
        'timeout': 30.0,  # Network timeout in seconds
        'batch_size': 50,  # Number of records to fetch in each request
        'max_attempts': 3,  # Number of times to make a request before failing
        'callback_url': '{}?id='.format(
            reverse('connectwise:callback')
        ),
        'callback_host': '{}://{}'.format(
            'http' if DEBUG else 'https',
            'djconnectwise-host.example.com'
        ),
    }
DJCONNECTWISE_CONF_CALLABLE = djconnectwise_configuration

For ConnectWise Cloud users, CONNECTWISE_SERVER_URL can be just i.e. https://na.myconnectwise.net- the library changes to the api-region domain automatically.

The DJCONNECTWISE_CONF_CALLABLE function should return a dictionary with the fields shown above. It's a callable so that it can fetch settings at runtime- for example from Constance settings.

Sync objects with this management command: cwsync. This will take a very long time if there are many objects to fetch.
Register your callbacks with the management command: callbacks_registered
Use standard Django model signals to see when objects change.
To control how user avatar thumbnails are stored, add settings from easy-thumbnails.

To de-register your callbacks, use the callbacks_deleted management command.

Testing

Prepare your environment:

pip install --upgrade -r requirements.txt
pip install --upgrade -r requirements_test.txt
pip install -e .

Try one of:

./runtests.py
make test

Contributing

Fork this repo
Make a branch
Make your improvements

Making migrations? Run:
```
./makemigrations.py
```
Run the tests (see above)
Make a pull request

License

MIT

Copyright

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_connectwise-1.26.0.tar.gz (141.1 kB view details)

Uploaded Jul 30, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

django_connectwise-1.26.0-py3-none-any.whl (250.0 kB view details)

Uploaded Jul 30, 2026 Python 3

File details

Details for the file django_connectwise-1.26.0.tar.gz.

File metadata

Download URL: django_connectwise-1.26.0.tar.gz
Upload date: Jul 30, 2026
Size: 141.1 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for django_connectwise-1.26.0.tar.gz
Algorithm	Hash digest
SHA256	`8c74927af5fb5062812c03f34bb2723108b7deeac2c90a18e18a47bb0e8f7e54`
MD5	`7541ba7e838684bb7656560aaaeccffe`
BLAKE2b-256	`1b727446557279eec92feeffa5f64ba3938f58443922a86a1e315a10e4c22c42`

See more details on using hashes here.

File details

Details for the file django_connectwise-1.26.0-py3-none-any.whl.

File metadata

Download URL: django_connectwise-1.26.0-py3-none-any.whl
Upload date: Jul 30, 2026
Size: 250.0 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for django_connectwise-1.26.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`3dfb6698aa73e1e7b4f48efc7f47b0062d1701d0afc56e90296732592177dbc0`
MD5	`4ce73ba3902b76d94bf2786a972f56bd`
BLAKE2b-256	`2bfc29dc47356db6185abde2a192ca8023041f7f9653e90a121b66a363e58c00`