update setup.py

convert README to rst, add badge

Author: Petr

README.md

@@ -0,0 +1,62 @@
+.. image:: https://img.shields.io/pypi/v/flask_replicated.svg
+        :target: https://pypi.python.org/pypi/flask_replicated
+
+SUMMARY
+-------
+
+Flask replicated is a Flask extension, designed to work with
+SqlAlchemy. It's purpose it to provide more or less automatic
+master-slave replication. On each request, extension determines database
+usage intention (to read or to write into a database). Then, it picks
+right database url inside overriden ``db.get_engine()`` whenever request
+handler tries to access database.
+
+INSTALLATION
+------------
+
+1. Install flask replicated distribution using ``pip install flask_replicated``.
+
+2. In flask ``app.config`` configure your database bindings a standard way::
+
+       SQLALCHEMY_DATABASE_URI = '%(schema)s://%(user)s:%(password)s@%(master_host)s/%(database)s'
+       SQLALCHEMY_BINDS = {
+           'master': SQLALCHEMY_DATABASE_URI,
+           'slave': '%(schema)s://%(user)s:%(password)s@%(slave_host)s/%(database)s'
+       }
+
+3. Register app extension::
+
+       app = Flask(...)
+       ...
+       FlaskReplicated(app)
+
+USAGE
+-----
+
+Flask replicated routes SQL queries into different databases based on
+request method. If method is one of ``READONLY_METHODS`` which are defined
+as set(['GET', 'HEAD'])
+
+While this is usually enough there are cases when DB access is not
+controlled explicitly by your business logic. Good examples are implicit
+creation of sessions on first access, writing some bookkeeping info,
+implicit registration of a user account somewhere inside the system.
+These things can happen at arbitrary moments of time, including during
+GET requests.
+
+To handle these situations wrap appropriate view function with
+``@flask_replicated.changes_database`` decorator. It will mark function to
+always use master database url.
+
+Conversely, wrap the view function with the ``@use_slave_database``
+decorator if you want to ensure that it always uses the slave replica.
+
+GET after POST
+~~~~~~~~~~~~~~
+
+There is a special case that needs addressing when working with
+asynchronous replication scheme. Replicas can lag behind a master
+database on receiving updates. In practice this mean that after
+submitting a POST form that redirects to a page with updated data this
+page may be requested from a slave replica that wasn't updated yet. And
+the user will have an impression that the submit didn't work.

README.rst

@@ -1,69 +1,8 @@
 from setuptools import setup
 
 
-readme = """
-SUMMARY
--------
-
-Flask\_replicated is a Flask extension, designed to work with
-SqlAlchemy. It's purpose it to provide more or less automatic
-master-slave replication. On each request, extension determines database
-usage intention (to read or to write into a database). Then, it picks
-right database url inside overriden db.get\_engine() whenever request
-handler tries to access database.
-
-INSTALLATION
-------------
-
-1. Install flask\_replicated distribution using "python setup.py
-   install".
-
-2. In flask app.config configure your database bindings a standard way:
-
-   ::
-
-       SQLALCHEMY_DATABASE_URI = '%(schema)s://%(user)s:%(password)s@%(master_host)s/%(database)s'
-       SQLALCHEMY_BINDS = {
-           'master': SQLALCHEMY_DATABASE_URI,
-           'slave': '%(schema)s://%(user)s:%(password)s@%(slave_host)s/%(database)s'
-       }
-
-3. Register app extension:
-
-   ::
-
-       app = Flask(...)
-       ...
-       FlaskReplicated(app)
-
-USAGE
------
-
-Flask\_replicated routes SQL queries into different databases based on
-request method. If method is one of READONLY\_METHODS which are defined
-as set(['GET', 'HEAD'])
-
-While this is usually enough there are cases when DB access is not
-controlled explicitly by your business logic. Good examples are implicit
-creation of sessions on first access, writing some bookkeeping info,
-implicit registration of a user account somewhere inside the system.
-These things can happen at arbitrary moments of time, including during
-GET requests.
-
-To handle these situations wrap appropriate view function with
-@flask\_replicated.changes\_database decorator. It will mark function to
-always use master database url.
-
-GET after POST
-~~~~~~~~~~~~~~
-
-There is a special case that needs addressing when working with
-asynchronous replication scheme. Replicas can lag behind a master
-database on receiving updates. In practice this mean that after
-submitting a POST form that redirects to a page with updated data this
-page may be requested from a slave replica that wasn't updated yet. And
-the user will have an impression that the submit didn't work.
-"""
+with open('README.rst') as fp:
+    readme = fp.read()
 
 
 setup(
@@ -86,6 +25,10 @@
         'Programming Language :: Python :: 2',
         'Programming Language :: Python :: 2.6',
         'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
     ],
     version='1.3',
     py_modules=['flask_replicated'],