Metadata-Version: 2.1
Name: NEMO-osticket
Version: 1.5.2
Summary: osTicket plugin for NEMO linking tickets to a specific tool
Author-email: Atlantis Labs LLC <atlantis@atlantislabs.io>
License: MIT License
        
        Copyright (c) 2024 Atlantis Labs LLC
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://gitlab.com/nemo-community/atlantis-labs/nemo-osticket
Project-URL: Changelog, https://gitlab.com/nemo-community/atlantis-labs/nemo-osticket/-/releases
Project-URL: Issues, https://gitlab.com/nemo-community/atlantis-labs/nemo-osticket/-/issues
Project-URL: CI, https://gitlab.com/nemo-community/atlantis-labs/nemo-osticket/-/pipelines
Keywords: NEMO
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: django
Requires-Dist: requests
Requires-Dist: mysql-connector-python==9.0.0
Provides-Extra: nemo
Requires-Dist: NEMO>=6.0.0; extra == "nemo"
Provides-Extra: nemo-ce
Requires-Dist: NEMO-CE>=6.0.0; extra == "nemo-ce"
Provides-Extra: dev-tools
Requires-Dist: pre-commit; extra == "dev-tools"
Requires-Dist: djlint; extra == "dev-tools"
Requires-Dist: black; extra == "dev-tools"

from NEMO_osticket.tests.test_settings import DATABASES

# NEMO-osticket

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/NEMO-osticket?label=python)](https://www.python.org/downloads/release/python-3110/)
[![PyPI](https://img.shields.io/pypi/v/nemo-osticket?label=pypi%20version)](https://pypi.org/project/NEMO-osticket/)
[![Changelog](https://img.shields.io/gitlab/v/release/nemo-community/atlantis-labs/nemo-osticket?include_prereleases&label=changelog)](https://gitlab.com/nemo-community/atlantis-labs/nemo-osticket/-/releases)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://gitlab.com/nemo-community/atlantis-labs/nemo-osticket/blob/main/LICENSE)

osTicket plugin for NEMO linking tickets to a specific tool

## Installation

```bash
python -m install nemo-osticket
```

### In settings.py:

1. Add `NEMO_osticket` to `INSTALLED_APPS`:

```python
INSTALLED_APPS = [
    '...',
    'NEMO_osticket', # This needs to be before NEMO
    '...',
    'NEMO',
]
```

2. Add `osticket` database information:
```python
DATABASES = {
    'default': {'...'},
    "osticket": {
        "ENGINE": "mysql.connector.django",
        'NAME': '<db_name>', # usually 'osticket'
        'USER': '<db_user>', # usually 'osticket'
        'PASSWORD': '<db_password>',
        'HOST':'<db_host>',
        'PORT':'<db_port>',
    }
}
```

3. Add an osticket API config dictionary:
```python
OSTICKET_SERVICE = {
    "available": True,
    "url": "https://myosticketservice.com",
    'keyword_arguments': {
        'timeout': 5, # optional
        'headers': {"X-API-Key": "<api_key>"}
    },
}
```

## Usage

Go to Administration -> Customization to configure this plugin and how to match Tool with Tickets from OsTicket

# Tests

To run the tests:
```bash
python runtests.py
```
