django-connectwise


Namedjango-connectwise JSON
Version 0.3.162 PyPI version JSON
download
home_pagehttps://github.com/KerkhoffTechnologies/django-connectwise
SummaryDjango app for working with ConnectWise. Defines models (tickets, members, companies, etc.) and callbacks.
upload_time2021-08-07 00:09:16
maintainer
docs_urlNone
authorKerkhoff Technologies Inc.
requires_python
licenseMIT
keywords django connectwise rest api python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # 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',
        ...
    ]
    ```

1. Add to `urls.py`:

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

1. 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](https://github.com/jazzband/django-constance) settings.
1. Sync objects with this management command: `cwsync`. This will take a very long time if there are many objects to fetch.
1. Register your callbacks with the management command: `callbacks_registered`
1. Use standard Django model signals to see when objects change.
1. To control how user avatar thumbnails are stored, add settings from 
   [easy-thumbnails](https://easy-thumbnails.readthedocs.io/en/stable/ref/settings/).

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.
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/KerkhoffTechnologies/django-connectwise",
    "name": "django-connectwise",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "django connectwise rest api python",
    "author": "Kerkhoff Technologies Inc.",
    "author_email": "matt@kerkhofftech.ca",
    "download_url": "https://files.pythonhosted.org/packages/d3/02/b1d1e42cc2bfbb20166e7565f916e7bfcc472ab7605c19df847720f66d1c/django-connectwise-0.3.162.tar.gz",
    "platform": "",
    "description": "# django-connectwise\n\nDjango app for working with ConnectWise. Defines models (tickets,\nmembers, companies, etc.) and callbacks.\n\n## Requirements\n\n-  Python 3.5\n-  Django 2.0\n\nOther versions may work; we haven't tried.\n\n## Installation\n\nFrom PyPI:\n\n    pip install django-connectwise\n\nFrom source:\n\n    git clone git@github.com:KerkhoffTechnologies/django-connectwise.git\n    cd django-connectwise\n    python setup.py install\n\n## Usage\n\n1. Add to INSTALLED_APPS\n\n    ```\n    INSTALLED_APPS = [\n        ...\n        'djconnectwise',\n        ...\n    ]\n    ```\n\n1. Add to `urls.py`:\n\n    ```\n    re_path(\n        r'^callback/',  # This can be whatever you want.\n        include('djconnectwise.urls', namespace='connectwise')\n    ),\n    ```\n\n1. Add to settings:\n\n    ```\n    CONNECTWISE_SERVER_URL = 'https://connectwise.example.com'\n    CONNECTWISE_CREDENTIALS = {\n        'company_id': 'your company ID',\n        'api_public_key': 'your API user public key',\n        'api_private_key': 'your API user private key',\n    }\n    CONNECTWISE_TICKET_PATH = 'v4_6_release/services/system_io/router/openrecord.rails'\n    def djconnectwise_configuration():\n        return {\n            'timeout': 30.0,  # Network timeout in seconds\n            'batch_size': 50,  # Number of records to fetch in each request\n            'max_attempts': 3,  # Number of times to make a request before failing\n            'callback_url': '{}?id='.format(\n                reverse('connectwise:callback')\n            ),\n            'callback_host': '{}://{}'.format(\n                'http' if DEBUG else 'https',\n                'djconnectwise-host.example.com'\n            ),\n        }\n    DJCONNECTWISE_CONF_CALLABLE = djconnectwise_configuration\n    ```\n\n    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.\n      \n    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](https://github.com/jazzband/django-constance) settings.\n1. Sync objects with this management command: `cwsync`. This will take a very long time if there are many objects to fetch.\n1. Register your callbacks with the management command: `callbacks_registered`\n1. Use standard Django model signals to see when objects change.\n1. To control how user avatar thumbnails are stored, add settings from \n   [easy-thumbnails](https://easy-thumbnails.readthedocs.io/en/stable/ref/settings/).\n\nTo de-register your callbacks, use the `callbacks_deleted` management command.\n\n## Testing\n\nPrepare your environment:\n\n```\npip install --upgrade -r requirements_test.txt\n```\n\nTry one of:\n\n    ./runtests.py\n    python setup.py test\n    make test\n\n## Contributing\n\n- Fork this repo\n- Make a branch\n- Make your improvements\n\n    Making migrations? Run:\n\n    ```\n    ./makemigrations.py\n    ```\n\n- Run the tests (see above)\n- Make a pull request\n\n## License\n\nMIT\n\n## Copyright\n\n\u00a9 2017 Kerkhoff Technologies Inc.",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Django app for working with ConnectWise. Defines models (tickets, members, companies, etc.) and callbacks.",
    "version": "0.3.162",
    "split_keywords": [
        "django",
        "connectwise",
        "rest",
        "api",
        "python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "0573a73565d4cb5dc8a2ec0ae000b987",
                "sha256": "832cb1894a4206f6e96331fd7a655ab3b29a5ad3f6f39f5eb7b2d1f054d3cc04"
            },
            "downloads": -1,
            "filename": "django-connectwise-0.3.162.tar.gz",
            "has_sig": false,
            "md5_digest": "0573a73565d4cb5dc8a2ec0ae000b987",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 293575,
            "upload_time": "2021-08-07T00:09:16",
            "upload_time_iso_8601": "2021-08-07T00:09:16.844715Z",
            "url": "https://files.pythonhosted.org/packages/d3/02/b1d1e42cc2bfbb20166e7565f916e7bfcc472ab7605c19df847720f66d1c/django-connectwise-0.3.162.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-08-07 00:09:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "KerkhoffTechnologies",
    "github_project": "django-connectwise",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": false,
    "tox": true,
    "lcname": "django-connectwise"
}
        
Elapsed time: 0.36917s