Init README and library

Author: Emmanouil Konstantinidis

README.md

@@ -1,2 +1,30 @@
-# django-rest-framework-api-key
+# django-rest-framework-api-key [![travis][travis-image]][travis-url] [![pypi][pypi-image]][pypi-url]
 Authenticate Web APIs made with Django REST Framework
+
+
+### Supports
+
+  - Python (2.7, 3.3, 3.4, 3.5)
+  - Django (1.8, 1.9, 1.10)
+  - Django Rest Framework (3+)
+
+
+### Installation
+
+Install using pip:
+
+    pip install drfapikey
+
+Add 'rest_framework_api_key' to your `INSTALLED_APPS` setting:
+
+    INSTALLED_APPS = (
+        ...
+        'rest_framework_api_key',
+    )
+
+
+[travis-image]: https://travis-ci.org/ekonstantinidis/django-rest-framework-api-key.svg?branch=master
+[travis-url]: https://travis-ci.org/ekonstantinidis/django-rest-framework-api-key
+
+[pypi-image]: https://badge.fury.io/py/django-rest-framework-api-key.svg
+[pypi-url]: https://pypi.python.org/pypi/django-rest-framework-api-key/

rest_framework_api_key/admin.py

@@ -0,0 +1,32 @@
+from django.contrib import admin
+from django.contrib import messages
+from rest_framework_api_key.models import APIKey
+from rest_framework_api_key.helpers import generate_key
+
+
+class ApiKeyAdmin(admin.ModelAdmin):
+    list_display = ('id', 'name', 'created', 'modified')
+
+    fieldsets = (
+        ('Required Information', {'fields': ('name',)}),
+        ('Additional Information', {'fields': ('key_message',)}),
+    )
+    readonly_fields = ('key_message',)
+
+    search_fields = ('id', 'name',)
+
+    def has_delete_permission(self, request, obj=None):
+        return False
+
+    def key_message(self, obj):
+        if obj.key:
+            return "Hidden"
+        return "The API Key will be generated once you click save."
+
+    def save_model(self, request, obj, form, change):
+        if not obj.key:
+            obj.key = generate_key()
+            messages.add_message(request, messages.WARNING, ('The API Key for %s is %s. Please note it since you will not be able to see it again.' % (obj.name, obj.key)))
+        obj.save()
+
+admin.site.register(APIKey, ApiKeyAdmin)

rest_framework_api_key/helpers.py

@@ -0,0 +1,6 @@
+import binascii
+import os
+
+
+def generate_key():
+    return binascii.hexlify(os.urandom(20)).decode()

rest_framework_api_key/permissions.py

@@ -0,0 +1,10 @@
+from rest_framework import permissions
+from rest_framework_api_key.models import APIKey
+
+
+class HasAPIAccess(permissions.BasePermission):
+    message = 'Invalid or missing API Key.'
+
+    def has_permission(self, request, view):
+        api_key = request.META.get('HTTP_API_KEY', '')
+        return APIKey.objects.filter(key=api_key).exists()

runtests.py

@@ -5,7 +5,7 @@
 
 
 FLAKE8_ARGS = ['rest_framework_api_key', 'tests/', '--ignore=E501']
-PYTEST_ARGS = ['tests', '--tb=short', '-s', '-rw']
+PYTEST_ARGS = ['tests', '--cov=rest_framework_api_key', '--tb=short']
 
 
 def exit_on_failure(command, message=None):

tests/test_settings.py renamed to tests/settings.py

@@ -1,5 +1,5 @@
 [pytest]
-DJANGO_SETTINGS_MODULE=tests.test_settings
+DJANGO_SETTINGS_MODULE=tests.settings
 
 [tox]
 envlist =