Metadata-Version: 2.1
Name: django-umsebenzi
Version: 1.2.2
Summary: 'A set of django rest apis to manage your personal projects and tasks'
Home-page: https://github.com/StandaloneDynamics/django-umsebenzi
Author: Menzi Mthembu
License: GPL v3.0
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: django~=4.2
Requires-Dist: djangorestframework~=3.14
Requires-Dist: django_enumfield~=3.1
Requires-Dist: django-filter~=23.5

# Django-Umsebenzi

Umsebenzi, which means work in the Zulu language, is a set of simple Django REST apis to manage and keep track of your personal
projects and tasks.

It consists of 2 Endpoints:

* Projects
* Tasks

# Installation
```
pip install django-umsebenzi
```

# Setup

* Add the app `umsebenzi` to `INSTALLED_APPS`
* Umsebenzi uses `DefaultRouter` for its urls. To add it to your main router in your project:
```
from umsebenzi.urls import router as umsebenzi_router 

main_router.registry.extend(umsebenzi_router.registry)
```

Once the urls are connected you will be to view docs if you have the swagger tool for api documentation
There are some examples below to see some of the data that can be created


# Docs
* [Project Api Example](docs/project.md)
* [Tasks Api Example](docs/task.md)

# OpenAPI Endpoints

![screenshot of endpoints](api_endpoints.png)
