Skip to main content

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

Project description

django-connectwise

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

Requirements

  • Python 3.5
  • Django 2.0

Other versions may work; we haven't tried.

Installation

From PyPI:

pip install django-connectwise

From source:

git clone git@github.com:KerkhoffTechnologies/django-connectwise.git
cd django-connectwise
python setup.py install

Usage

  1. Add to INSTALLED_APPS

    INSTALLED_APPS = [
        ...
        'djconnectwise',
        ...
    ]
    
  2. Add to urls.py:

    re_path(
        r'^callback/',  # This can be whatever you want.
        include('djconnectwise.urls', namespace='connectwise')
    ),
    
  3. 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.

  4. Sync objects with this management command: cwsync. This will take a very long time if there are many objects to fetch.

  5. Register your callbacks with the management command: callbacks_registered

  6. Use standard Django model signals to see when objects change.

  7. 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_test.txt

Try one of:

./runtests.py
python setup.py test
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

© 2017 Kerkhoff Technologies Inc.

Project details


Release history Release notifications | RSS feed

This version

1.9.0

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.9.0.tar.gz (312.1 kB view details)

Uploaded Source

File details

Details for the file django-connectwise-1.9.0.tar.gz.

File metadata

  • Download URL: django-connectwise-1.9.0.tar.gz
  • Upload date:
  • Size: 312.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.10

File hashes

Hashes for django-connectwise-1.9.0.tar.gz
Algorithm Hash digest
SHA256 a27442aefc45addc4d24fbe60cdfba6fca5576728cab675ecd1d65be24c3d592
MD5 689e0de66ce2f33c97651d9144a2c16f
BLAKE2b-256 0cf6fe4f5b06c20c957a77a9445f43abcf14781a657eb9005e88c24718e954a7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page