Metadata-Version: 2.3
Name: python-neaktor-api
Version: 2.0.0
Summary: Package to interact with neaktor API
Project-URL: Homepage, https://github.com/tkvitko/python-neaktor-api
Project-URL: Issues, https://github.com/tkvitko/python-neaktor-api/issues
Author-email: Taras Kvitko <tkvitko@gmail.com>
License-File: LICENCE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# Python Neaktor API wrapper
Python lib to interact with Neaktor

Neaktor docs:
- https://neaktor.com/
- https://developers.neaktor.com/#/overview 

## Installation
``pip install python-neaktor-api``

## Usage

```python
from neaktor import NeaktorApiClient, User, Task, TaskModel, Comment

my_public_key = 'test'
api = NeaktorApiClient(public_key=my_public_key)

my_tasks: List[Task] = api.get_tasks()
my_users: List[User] = api.get_users(user_ids={1, 2})
my_task_models: List[TaskModel] = api.get_task_models()
new_task: Task = api.add_task(model_id='my_model_id', fields={'subject': 'my new task'}, assignee_id=1234)
new_comment: Comment = api.add_comment(task_id='my_task_id', text='my comment')
deletion_status: dict = api.delete_task(task_id=1)

```

## Functionality
### Supports
- public key authorization
- getting tasks list
- getting task models list
- getting users list
- adding tasks
- adding comments to tasks
- deleting tasks

### Roadmap
- all other api methods
