Metadata-Version: 2.1
Name: django-typescript
Version: 0.1
Summary: A Django app to generate typings from Django application models
Author-email: Roberto Rodriguez <roberto@biglargeclarke.com>
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 5.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
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.11
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: django >=5.1.1

# Django Typescript

Django Typescript generates typings against your Django application models

**Please note that this is a work in progress and is not yet ready for real use.**

## Getting Started

This package has only been tested against Django 5.1

### Getting It

    $ pip install django-typescript

### Installing It

To enable `django_typescript` in your project you need to add it to `INSTALLED_APPS` in your projects
`settings.py` file:

```python
INSTALLED_APPS = (
    ...
    'django_typescript',
    ...
)
```
    
You will also need to specify a directory to store generated typings:

```python
DJANGO_TYPESCRIPT_DIR='types'
```


### Using It

Generate types:

    $ python manage.py generate_types
