Metadata-Version: 1.1
Name: api-browser
Version: 0.0.12
Summary: API Browser
===========

An API browser for Django Rest Framework.


Installation
============

Installing the api-browser package
----------------------------------

The API Browser is ``pip`` installable from the Gemfury package repository.

.. code:: shell

    pip install api-browser --extra-index-url https://pypi.fury.io/nickfrez/


The API Browser is not yet available as a PyPI package.


Installing from Github
----------------------

You can install the latest version of the API Browser directly from Github:

.. code:: shell

    pip install git+http://github.com/jacktrades/api-browser.git#egg=api_browser


Installing from a local checkout for development
------------------------------------------------

.. code:: shell

    pip install -e /path/to/repo#egg=api_browser



Configuration
=============

Add api_browser to installed apps
---------------------------------

.. code:: python

    INSTALLED_APPS += ['api_browser']

    REST_FRAMEWORK = {
        'DEFAULT_METADATA_CLASS': 'api_browser.metadata.DocumentationMetadata',

        'DEFAULT_RENDERER_CLASSES': (
            'api_browser.renderers.APIBrowserRenderer',
            'rest_framework.renderers.BrowsableAPIRenderer',
            'rest_framework.renderers.JSONRenderer')

        'VIEW_NAME_FUNCTION': (
            'api_browser.renderers.get_view_name'),

        'VIEW_DESCRIPTION_FUNCTION': (
            'api_browser.renderers.get_view_description'),
    }

    API_BROWSER = {
        'TEMPLATE': 'api_browser/drf_api.html',
    }


Documentation
=============

Documentation for API Browser can be found in the ``/docs`` directory.


Building the Docs
-----------------

Build the docs using the UNB CLI:

.. code:: shell

    unb docs build



Versioning
==========

The API Browser project follows `PEP 440
<https://www.python.org/dev/peps/pep-0440/>`_ and `SemVer 2.0.0
<http://semver.org/spec/v2.0.0.html>`_.  More information can be found in the
documentation.

.. WARNING:: This project is in the alpha stage of development and the API
             should not be considered stable!



Issue Reporting and Contact Information
=======================================

If you have any problems with this software, please take a moment to report
them at https://bitbucket.org/nickfrez/api-browser/issues or  by email to
nick@frez.me.

If you are a security researcher or believe you have found a security
vulnerability in this software, please contact us by email at nick@frez.me.



Copyright and License Information
=================================

Copyright (c) 2016 Nick Frezynski

This project is licensed under the MIT license.  Please see the LICENSE file
for more information.
Home-page: https://bitbucket.org/nickfrez/api-browser
Author: Nick Frezynski
Author-email: nick@frez.me
License: MIT
Description-Content-Type: UNKNOWN
Description: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.9
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: OS Independent
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Software Development :: Documentation
