Merge pull request #8 from ekonstantinidis/rebrand

ekonstantinidis · ekonstantinidis · commit 235bd76ffea8 · 2015-12-14T19:52:06.000Z
Rebrand Project
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,4 @@
 __pycache__/
 
 env/
-drfdocs.egg-info/
+djangorestframeworkdocs.egg-info/
diff --git a/.travis.yml b/.travis.yml
@@ -1,9 +1,11 @@
 language: python
 
 python:
+  - "2.7"
   - "3.3"
   - "3.4"
   - "3.5"
+  - "pypy"
   - "pypy3"
 
 install:
@@ -14,4 +16,4 @@ script:
 
 notifications:
   slack:
-    secure: ITmN/3Db23HEcHP5pwoBjGE3qC5w/vOhCOGoefBTGV133YPqcAft1TDA+qQRcB87Da2qcechiR8DwWYVSbugd52lnOnEgwyb+fpTLKKyzU6u5QP6sMjBo+umLwwQSLp9UlctdbgidEOZlYML7H7LTwXrek5g/HXWawHZ90jr60rLKa0qVqFlljx+663VAiw07ro1gx66q60Ptc40OYstgskCVEG2Nb6vCMhE2bqvLRlTBoFvkdLGJdJW9S+WofJMNlRJBHK/boLpWx2/fS6IJFJxo3HvFHcu79OBoe7Oi3WYPjikZB2iNOAv1rHGq7GlFqAiHgnG4USDLyl8vyagsAqwllIcNtNoPh3Yu3TsfGDYs3opRKSLxMp1pvWNLAI1D7y55zPVCdADUziLjBSYSSd0Mcws/plmex7g+N8y650aQu5lVRysiN0Ug9YnQsOKNIAGL4s7/BIlDRtN5ZkUdPmRjrqrBK74eiKBZi+JVkoQTIBiQ2qr2/UugYfwUuB1NSIiIGujHu9j4KPooeVzgJdRIGYTPCQH9TYQ3Al/iY+cbVBecTf6mbEsXDsNrRfGJcI1K3G3YLP3buzGzQoTpR/buTnwgRMiXMuTIx4/I5jmYFSnvSK86O/kpGbPCMXIG9MMmldBy95y1D10CAKr8WRwiw0dYzJ+cdJz2GKWhEk=
+    secure: ZTzxh+tXuf7uaFMBQtrjupS+qqtM3dsnYgHptErsg3SjH0q1jH+HpKD+1RlqGqN36mREB1wSlOhGMzfyGNeNhl0PHQLEtZhs3dRLdzR1xMZWKm7xtCe4TcFoSPh5SoLOHrQVaSEyHeE53gkbOfI7Q5SqVRJOlJv9iCCD8TM+KVdDubCeByevunFSzGFwdLvtk7QpRwXivOGJdJHXXWgVl6ieviQKun5Z03woiLr5L4p37szVkbD60T5lFYAhCL1PzLQ6hVhDn7L4J06LIaQ+l+Jp6cunB1iJtR1Rz+C7g/r2VGgJ5G3sHB3QyFqw9Q/E3oBB81xQTwjL7WSfDuKctW2CPWHac0T9VhidQDoq7uR0EYPMkZXnc+iZa5wmL8IfjEadse0rxdfiIOE+mev+i5BrzHBq/+tZV/D+HKzsRXUEf3BZaRpq7gQHWbj0dusX+R504BQtKqYaGqBFdWJ0+Dry739R4xTeWk10Xa3wpzSFQ1c0yUQbY+3W/DNSYKcRV+Z9eGhMSO1QfBlGzqTlkWkVDnD9OYIpo5iJOkDouJVtzPOyyFBoNGqkvUHiKBO6ohuh48S3xXrjhihkz8xuOSrU1W7xGhCG2RA/vHZh8Fm20l1oIJ/p/Gn6kTLT33XZsxnF9C0Qmgvr6f96MKNPJjNKp0zYj4tJaZr9Xi4rsD8=
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# drf-docs [![travis][travis-image]][travis-url] [![pypi][pypi-image]][pypi-url]
+# [Django Rest Framework Docs](http://www.drfdocs.com/) [![travis][travis-image]][travis-url] [![pypi][pypi-image]][pypi-url]
 
 Document Web APIs made with Django Rest Framework.
 
@@ -22,24 +22,42 @@ Document Web APIs made with Django Rest Framework.
 
 Install using pip:
 
-    pip install drfdocs
+    pip install djangorestframeworkdocs
 
-Add 'drfdocs' to your `INSTALLED_APPS` setting:
+Add 'rest_framework_docs' to your `INSTALLED_APPS` setting:
 
     INSTALLED_APPS = (
         ...
-        'drfdocs',
+        'rest_framework_docs',
     )
 
-Finally include the `drfdocs` urls in your `urls.py`:
+Finally include the `rest_framework_docs` urls in your `urls.py`:
 
     urlpatterns = [
         ...
-        url(r'^docs/', include('drfdocs.urls', app_name='drfdocs', namespace='drfdocs')),
+        url(r'^docs/', include('rest_framework_docs.urls')),
     ]
 
-[travis-image]: https://travis-ci.com/ekonstantinidis/drf-docs.svg?token=9QR4ewbqbkEmHps6q5sq&branch=master
-[travis-url]: https://travis-ci.com/ekonstantinidis/drf-docs
+### Settings
 
-[pypi-image]: https://img.shields.io/pypi/v/drfdocs.svg
-[pypi-url]: https://pypi.python.org/pypi/drffocs/
+    REST_FRAMEWORK_DOCS = {
+        'HIDDEN': True  # Default: False
+    }
+
+### Roadmap
+
+  - [ ] Support Python 2 & Python 3
+  - [ ] Support DRF 3+
+  - [ ] Open Pull Request to include in DRF
+  - [ ] Submit to djangopackages.com
+
+
+### Credits
+
+First of all thanks to the [Django](http://www.djangoproject.com/) core team and to all the contributors of [Django REST Framework](http://www.django-rest-framework.org/) for their amazing work. Also I would like to thank [Marc Gibbons](https://github.com/marcgibbons) for his *django-rest-framework-docs* project. Both projects share the same idea, it is just that Marc's is not maintained anymore and does not support DRF 3+ & Python 3.
+
+[travis-image]: https://travis-ci.com/ekonstantinidis/django-rest-framework-docs.svg?token=9QR4ewbqbkEmHps6q5sq&branch=master
+[travis-url]: https://travis-ci.com/ekonstantinidis/django-rest-framework-docs
+
+[pypi-image]: https://img.shields.io/pypi/v/djangorestframeworkdocs.svg
+[pypi-url]: https://pypi.python.org/pypi/djangorestframeworkdocs/
diff --git a/drfdocs/views.py b/drfdocs/views.py
diff --git a/rest_framework_docs/__init__.py b/rest_framework_docs/__init__.py
diff --git a/rest_framework_docs/api_docs.py b/rest_framework_docs/api_docs.py
@@ -1,12 +1,10 @@
 from django.conf import settings
 from django.core.urlresolvers import RegexURLResolver, RegexURLPattern
-from drfdocs.api_endpoint import ApiEndpoint
 from rest_framework.views import APIView
+from rest_framework_docs.api_endpoint import ApiEndpoint
 
 
 class ApiDocumentation(object):
-    excluded_apps = ["admin", "drfdocs"]
-    excluded_endpoints = ["serve"]
 
     def __init__(self):
         self.endpoints = []
@@ -15,9 +13,9 @@ def __init__(self):
 
     def get_all_view_names(self, urlpatterns, parent_pattern=None):
         for pattern in urlpatterns:
-            if isinstance(pattern, RegexURLResolver) and (pattern.app_name not in self.excluded_apps):
+            if isinstance(pattern, RegexURLResolver):
                 self.get_all_view_names(urlpatterns=pattern.url_patterns, parent_pattern=pattern)
-            elif isinstance(pattern, RegexURLPattern) and (pattern.callback.__name__ not in self.excluded_endpoints) and self._is_drf_view(pattern):
+            elif isinstance(pattern, RegexURLPattern) and self._is_drf_view(pattern):
                 api_endpoint = ApiEndpoint(pattern, parent_pattern)
                 self.endpoints.append(api_endpoint)
 
diff --git a/rest_framework_docs/api_endpoint.py b/rest_framework_docs/api_endpoint.py
diff --git a/rest_framework_docs/settings.py b/rest_framework_docs/settings.py
@@ -0,0 +1,19 @@
+from django.conf import settings
+
+
+class DRFSettings(object):
+
+    def __init__(self):
+        self.drf_settings = {
+            "HIDDEN": self.get_setting("HIDDEN") or False
+        }
+
+    def get_setting(self, name):
+        try:
+            return settings.REST_FRAMEWORK_DOCS[name]
+        except:
+            return None
+
+    @property
+    def settings(self):
+        return self.drf_settings
diff --git a/rest_framework_docs/static/less/style.less b/rest_framework_docs/static/less/style.less
diff --git a/rest_framework_docs/templates/rest_framework_docs/base.html b/rest_framework_docs/templates/rest_framework_docs/base.html
@@ -7,7 +7,7 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1">
 
-    <title>DRF Docs</title>
+    <title>{% block title %}DRF Docs{% endblock %}</title>
 
     <!-- Bootstrap & Flatly -->
     <link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.5/flatly/bootstrap.min.css" rel="stylesheet">
@@ -41,7 +41,7 @@
               <span class="icon-bar"></span>
               <span class="icon-bar"></span>
             </button>
-            <a class="navbar-brand" href="#">DRF Docs</a>
+            {% block logo %}<a class="navbar-brand" href="http://www.drfdocs.com/">DRF Docs</a>{% endblock %}
           </div>
 
           <!-- Collect the nav links, forms, and other content for toggling -->
@@ -65,6 +65,7 @@ <h3>Document Web APIs made with <a href="http://www.django-rest-framework.org/"
 
       {% block content %}{% endblock %}
 
+      {% block footer %}
       <div class="footer">
         <div class="links">
           <a href="http://www.iamemmanouil.com"><i class="fa fa-link"></i></a>
@@ -73,6 +74,7 @@ <h3>Document Web APIs made with <a href="http://www.django-rest-framework.org/"
         </div>
         Copyright © 2015 Emmanouil Konstantinidis.
       </div>
+      {% endblock %}
     </div>
 
     <!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
diff --git a/rest_framework_docs/templates/rest_framework_docs/home.html b/rest_framework_docs/templates/rest_framework_docs/home.html
@@ -1,11 +1,10 @@
-{% extends "drfdocs/base.html" %}
+{% extends "rest_framework_docs/base.html" %}
 
 {% block apps_menu %}
 {% regroup endpoints by name_parent as endpoints_grouped %}
 <li class="dropdown">
   <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Jump To <span class="caret"></span></a>
   <ul class="dropdown-menu">
-    <!-- <li><a href="#dd">ddsf{{group.grouper}}</a></li> -->
     {% for group in endpoints_grouped %}
       <li><a href="#{{ group.grouper|lower }}">{{ group.grouper }}</a></li>
     {% endfor %}
diff --git a/rest_framework_docs/urls.py b/rest_framework_docs/urls.py
@@ -1,5 +1,5 @@
 from django.conf.urls import url
-from drfdocs.views import DRFDocsView
+from rest_framework_docs.views import DRFDocsView
 
 urlpatterns = [
     # Url to view the API Docs
diff --git a/rest_framework_docs/views.py b/rest_framework_docs/views.py
@@ -0,0 +1,19 @@
+from django.http import Http404
+from django.views.generic.base import TemplateView
+from rest_framework_docs.api_docs import ApiDocumentation
+from rest_framework_docs.settings import DRFSettings
+
+
+class DRFDocsView(TemplateView):
+
+    template_name = "rest_framework_docs/home.html"
+
+    def get_context_data(self, **kwargs):
+        settings = DRFSettings().settings
+        if settings["HIDDEN"]:
+            raise Http404("Django Rest Framework Docs are hidden. Check you settings.")
+
+        context = super(DRFDocsView, self).get_context_data(**kwargs)
+        docs = ApiDocumentation()
+        context['endpoints'] = docs.get_endpoints()
+        return context
diff --git a/runtests.py b/runtests.py
@@ -1,17 +1,18 @@
 #!/usr/bin/env python
-import os
 import sys
 import subprocess
 
 
-FLAKE8_ARGS = ['drfdocs', '--ignore=E501']
+FLAKE8_ARGS = ['rest_framework_docs', '--ignore=E501']
+
 
 def exit_on_failure(command, message=None):
     if command:
         sys.exit(command)
 
+
 def flake8_main(args):
-    print('Running: flake8', *FLAKE8_ARGS, sep=' ')
+    print('Running: flake8', FLAKE8_ARGS)
     command = subprocess.call(['flake8'] + args)
     print("" if command else "Success. flake8 passed.")
     return command
diff --git a/setup.py b/setup.py
@@ -1,8 +1,8 @@
 from setuptools import find_packages, setup
 
 setup(
-    name="drfdocs",
-    version=__import__('drfdocs').__version__,
+    name="djangorestframeworkdocs",
+    version=__import__('rest_framework_docs').__version__,
     author="Emmanouil Konstantinidis",
     author_email="manos@iamemmanouil.com",
     packages=find_packages(),
