https://github.com/codeasashu/openapi-documentor

Openapi documentation management in django
https://github.com/codeasashu/openapi-documentor

Last synced: 19 days ago
JSON representation

Openapi documentation management in django

• Host: GitHub
• URL: https://github.com/codeasashu/openapi-documentor
• Owner: codeasashu
• License: mit
• Created: 2021-03-19T13:21:06.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-09-14T09:01:31.000Z (over 1 year ago)
• Last Synced: 2024-10-06T00:41:23.411Z (3 months ago)
• Language: Python
• Size: 8.86 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Openapi Documentor

==================

Openapi documentation on django platform

.. image:: https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg?logo=cookiecutter

     :target: https://github.com/pydanny/cookiecutter-django/

     :alt: Built with Cookiecutter Django

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

     :target: https://github.com/ambv/black

     :alt: Black code style

:License: MIT

Settings

--------

Moved to settings_.

.. _settings: http://cookiecutter-django.readthedocs.io/en/latest/settings.html

Basic Commands

--------------

Setting Up Your Users

^^^^^^^^^^^^^^^^^^^^^

* To create a **normal user account**, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

* To create an **superuser account**, use this command::

    $ python manage.py createsuperuser

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Type checks

^^^^^^^^^^^

Running type checks with mypy:

::

  $ mypy openapi_documentor

Test coverage

^^^^^^^^^^^^^

To run the tests, check your test coverage, and generate an HTML coverage report::

    $ coverage run -m pytest

    $ coverage html

    $ open htmlcov/index.html

Running tests with py.test

~~~~~~~~~~~~~~~~~~~~~~~~~~

::

  $ pytest

Live reloading and Sass CSS compilation

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Moved to `Live reloading and SASS compilation`_.

.. _`Live reloading and SASS compilation`: http://cookiecutter-django.readthedocs.io/en/latest/live-reloading-and-sass-compilation.html

Deployment

----------

The following details how to deploy this application.

Docker

^^^^^^

See detailed `cookiecutter-django Docker documentation`_.

.. _`cookiecutter-django Docker documentation`: http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-docker.html