Merge pull request #20 from dipcode-software/feat/documentation

Feat/documentation

Author: srtab

AUTHORS.md

@@ -0,0 +1,8 @@
+# Authors
+
+We'd like to thank the following people for their contributions.
+
+- Paulo Truta <jpt@eurotux.com>
+- Sandro Rodrigues <srtabs@gmail.com>
+- Tiago Brito <tfb@eurotux.com>
+- Tiago Loureiro <tiagocostaloureiro@gmail.com>

CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## 0.1.0 - 2017-09-13
+- First release on PyPi

README.md

@@ -4,27 +4,28 @@
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/a64f03c2bd344561bc21e05c23aa04fb)](https://www.codacy.com/app/srtabs/django-ajax-views?utm_source=github.com&utm_medium=referral&utm_content=dipcode-software/django-ajax-views&utm_campaign=Badge_Grade)
 [![Coverage Status](https://coveralls.io/repos/github/dipcode-software/django-ajax-views/badge.svg?branch=master)](https://coveralls.io/github/dipcode-software/django-ajax-views?branch=master)
 
-Django module to easily use ajax forms.
+Django module to easily use generic views with ajax.
 
-## Install
+Table of contents:
+ * [How to install](#how-to-install);
+ * [License](#license).
+
+## How to install
 To install the app run :
 ```shell
 pip install django-ajax-views
 ```
 or add it to the list of requirements of your project.
 
-## Running tests
-To run tests we use tox:
+Then add 'ajax\_views' to your INSTALLED_APPS.
+```python
+INSTALLED_APPS = [
+    ...
+    'ajax_views',
+]
 ```
-# Run unit and flake
-$ tox
 
-# Run only unit tests
-$ tox -e py27
 
-# Run only flake8 tests
-$ tox -e flake8
+## License
 
-# Run coverage tests
-$ tox -e coverage
-```
+MIT license, see the LICENSE file. You can use obfuscator in open source projects and commercial products.

ajax_views/__init__.py

@@ -1 +1,7 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+
 default_app_config = 'ajax_views.apps.AjaxViewsConfig'
+
+__version__ = '0.1.0'

ajax_views/views.py

@@ -2,9 +2,9 @@
 from __future__ import absolute_import, unicode_literals
 
 from django.views.generic import (
-    TemplateView, CreateView, UpdateView, DeleteView)
+    CreateView, DeleteView, TemplateView, UpdateView)
 
-from .mixins import PartialAjaxMixin, FormAjaxMixin, AjaxResponseMixin
+from .mixins import AjaxResponseMixin, FormAjaxMixin, PartialAjaxMixin
 
 
 class TemplateAjaxView(PartialAjaxMixin, TemplateView):

setup.py

@@ -1,19 +1,13 @@
-import os
 from setuptools import find_packages, setup
 
-with open(os.path.join(os.path.dirname(__file__), 'README.md')) as readme:
-    README = readme.read()
-
-os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
 
 setup(
     name='django-ajax-partials',
-    version='0.1.0-alpha',
+    version=__import__("ajax_views").__version__,
     packages=find_packages(),
     include_package_data=True,
     license='MIT',
-    description='Django module to easily use ajax forms.',
-    long_description=README,
+    description='Django module to easily use generic views with ajax.',
     url='https://github.com/dipcode-software/django-ajax-partials/',
     author='Dipcode',
     author_email='info@dipcode.com',