Metadata-Version: 2.1
Name: django-welkin
Version: 0.0.1b1
Summary: A Django app interfacing with the Welkin API.
Home-page: https://pypi.org/project/django-welkin/
License: GPL-3.0-or-later
Author: Sam Morgan
Author-email: sam@lightmatter.com
Requires-Python: >=3.10,<4.0
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Dist: django-solo (>=2.0.0,<3.0.0)
Requires-Dist: welkin (>=0.0.6,<0.0.7)
Project-URL: Documentation, https://django-welkin.readthedocs.io/
Project-URL: Repository, https://github.com/lightmatter/django-welkin
Description-Content-Type: text/markdown

# Welkin

Welkin is a Django app to connect to the Welkin Health API.

## Quick start

1. Install django-welkin with pip:

```
pip install django-welkin
```

2. Add django-welkin and django-solo to your INSTALLED_APPS setting like this:

```python
INSTALLED_APPS = [
    ...
    "solo",
    'django_welkin',
]
```

3. Include the django-welkin URLconf in your project urls.py like this:

```python
path('welkin/', include('django_welkin.urls')),
```

4. Run `python manage.py migrate` to create the welkin models.

5. Start the development server and visit http://localhost:8000/admin/welkin/configuration/
   to and add API secrets to the singleton (you'll need the Admin app enabled).

