Metadata-Version: 2.4
Name: django-simple-docs
Version: 1.1.0
Summary: A ready-to-use package to add drf-spectacular docs to your DRF API.
License-Expression: MIT
Project-URL: Home Page, https://github.com/mrswats/django-simple-docs
Project-URL: Repository, https://github.com/mrswats/django-simple-docs
Project-URL: Github, https://github.com/mrswats/django-simple-docs
Classifier: Intended Audience :: Developers
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
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Requires-Python: >=3.14.1
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: django
Requires-Dist: djangorestframework
Requires-Dist: drf_spectacular
Provides-Extra: test
Requires-Dist: covdefaults; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-django; extra == "test"
Requires-Dist: pytest-randomly; extra == "test"
Requires-Dist: pytest-xdist; extra == "test"
Requires-Dist: time-machine; extra == "test"
Dynamic: license-file

# Django simple Docs

This is a django app to easily configure `drf_spectacular`.

## Instalation

Installing from PyPI:
```console
pip install django-simple-docs
```

Add the following settings in your project:

```python

INSTALLED_APPS = [
    ...,
    "django_simple_docs",
    "drf_spectacular",
    ...,
]

REST_FRAMEWORK = {
    ...,
    "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
    ...,
}

```

And, finally, configure the URLs:

```python
urlpatterns = [
    ...,
    path("api/docs/", include("django_simple_docs.urls")),
    ...,
]
```

Now, you can go to `http://localhost:8000/api/docs/` and browse the OpenAPI docs in your browser.

## Rationale

This is a simply configured drf_spectacular package for quickly getting started
with having OpenAPI docs withour much fuss. If you need more customization,
this package is probably not for you.

## Virtual Environment

Create a virtual Environment

```
virtualenv .venv -p pytthon 3.14
source .venv/bin/activate
```

## Tests

Using pytest for Tests

```
python -m pytest
```

## Formatting and Linting

Using pre-commit for linting and formatting

```
pre-commit install
pre-commit run --all-files
```
