https://github.com/apinf/apibot.ai

Turn OpenAPI specs to conversations with Developers in chat based environments.
https://github.com/apinf/apibot.ai

api-management apinf chatbot nlp openapi-spec slack

Last synced: 26 days ago
JSON representation

Turn OpenAPI specs to conversations with Developers in chat based environments.

• Host: GitHub
• URL: https://github.com/apinf/apibot.ai
• Owner: apinf
• License: other
• Created: 2017-03-21T15:22:08.000Z (over 7 years ago)
• Default Branch: develop
• Last Pushed: 2017-09-15T20:04:15.000Z (about 7 years ago)
• Last Synced: 2024-09-29T12:01:54.700Z (about 1 month ago)
• Topics: api-management, apinf, chatbot, nlp, openapi-spec, slack
• Language: Python
• Homepage: http://apibot.ai
• Size: 148 KB
• Stars: 2
• Watchers: 4
• Forks: 3
• Open Issues: 29
• Metadata Files:
  • Readme: README.rst
  • License: COPYING

Awesome Lists containing this project

README

        
.. image:: https://codeclimate.com/github/apinf/apibot.ai/badges/gpa.svg

   :target: https://codeclimate.com/github/apinf/apibot.ai

   :alt: Code Climate

.. image:: https://codeclimate.com/github/apinf/apibot.ai/badges/coverage.svg

   :target: https://codeclimate.com/github/apinf/apibot.ai/coverage

   :alt: Test Coverage

.. image:: https://codeclimate.com/github/apinf/apibot.ai/badges/issue_count.svg

   :target: https://codeclimate.com/github/apinf/apibot.ai

   :alt: Issue Count

.. image:: https://travis-ci.org/apinf/apibot.ai.svg?branch=develop

    :target: https://travis-ci.org/apinf/apibot.ai

apibot

======

API bot management by APInf.

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

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

     :alt: Built with Cookiecutter Django

:License: EUPL-1.1

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.

Test coverage

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

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

    $ coverage run manage.py test

    $ coverage html

    $ open htmlcov/index.html

Running tests with py.test

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

::

  $ py.test

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

Sentry

^^^^^^

Sentry is an error logging aggregator service. You can sign up for a free account at  https://sentry.io/signup/?code=cookiecutter  or download and host it yourself.

The system is setup with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.

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