Updated README.rst for pypi

README.md

@@ -13,7 +13,7 @@ django-admin-interface is a modern **responsive flat admin interface customizabl
 - Themes management and customization *(you can **customize admin title, logo and colors**)*
 - Responsive
 - List filter dropdown *(optional)*
-- **`NEW`** **Related modal** *(instead of the old popup window, optional)*
+- `NEW` **Related modal** *(instead of the old popup window, optional)*
 - Style optimizations for: `django-ckeditor`, `django-modeltranslation`, `sorl-thumbnail`
 
 ## Requirements
@@ -41,7 +41,7 @@ INSTALLED_APPS = (
 
 #### Upgrade
 - Run `pip install django-admin-interface --upgrade`
-- Run ``python manage.py migrate`` *(add ``--fake-initial`` if you are upgrading from 0.1.0 version)*
+- Run ``python manage.py migrate`` *(add* ``--fake-initial`` *if you are upgrading from 0.1.0 version)*
 - Run ``python manage.py collectstatic --clear``
 - Restart your application server
 
@@ -51,10 +51,10 @@ This package ships with optional themes as fixtures, they can be installed using
 ##### [Django](https://www.djangoproject.com/) theme (default):
 Run ``python manage.py loaddata admin_interface_theme_django.json``
 
-##### [Bootstrap](http://getbootstrap.com/) theme: 
+##### [Bootstrap](http://getbootstrap.com/) theme:
 Run ``python manage.py loaddata admin_interface_theme_bootstrap.json``
 
-##### [Foundation](http://foundation.zurb.com/) theme: 
+##### [Foundation](http://foundation.zurb.com/) theme:
 Run ``python manage.py loaddata admin_interface_theme_foundation.json``
 
 ##### [U.S. Web Design Standards](https://standards.usa.gov/) theme:
@@ -63,10 +63,10 @@ Run ``python manage.py loaddata admin_interface_theme_uswds.json``
 ### Add more themes
 You can add a theme you've created through the admin to this repository by [sending us a PR](http://makeapullrequest.com/). Here are the steps to follow to add :
 
-1. Export your exact theme as fixture using the `dumpdata` admin command: 
+1. Export your exact theme as fixture using the `dumpdata` admin command:
 ``python manage.py dumpdata admin_interface.Theme --indent 4 -o admin_interface_theme_{{name}}.json --pks=N``
 
-2. Copy the generated json file into the fixtures folder *(making sure its name starts with `admin_interface_theme_` to avoid clashes with fixtures that might be provided by other third party apps)*.
+2. Copy the generated json file into the fixtures folder *(making sure its name starts with* `admin_interface_theme_` *to avoid clashes with fixtures that might be provided by other third party apps)*.
 
 3. Remove the `"pk"` from the fixture and make sure the `active` field is set to `true` *(in this way a theme is automatically activated when installed)*.
 
@@ -88,13 +88,9 @@ You can add a theme you've created through the admin to this repository by [send
 ## FAQ
 - #### I already have a custom `base_site.html`, how can I make it work?
 
-You can use [django-apptemplates](https://github.com/bittner/django-apptemplates), then add **`{% extends "admin_interface:admin/base_site.html" %}`** to your `base_site.html`
+You can use [django-apptemplates](https://github.com/bittner/django-apptemplates), then add `{% extends "admin_interface:admin/base_site.html" %}` to your `base_site.html`
 
 ---
-#### Thanks
-- [django-flat-theme](https://github.com/elky/django-flat-theme/)
-- [django-flat-responsive](https://github.com/elky/django-flat-responsive)
-- [django-colorfield](https://github.com/jaredly/django-colorfield/)
 
 ## License
 Released under [MIT License](LICENSE).

README.rst

@@ -0,0 +1,142 @@
+|Build Status| |codecov| |Code Health| |PyPI version| |Py versions| |License|
+
+django-admin-interface
+======================
+
+django-admin-interface is a modern **responsive flat admin interface
+customizable by the admin itself**.
+
+Features
+--------
+
+- Beautiful default **django-theme**
+- Themes management and customization *(you can customize admin title, logo and colors)*
+- Responsive
+- List filter dropdown *(optional)*
+- ``NEW`` **Related modal** (instead of the old popup window, optional)
+- Style optimizations for: ``django-ckeditor``, ``django-modeltranslation``, ``sorl-thumbnail``
+
+Requirements
+------------
+
+- Python 2.7, 3.4, 3.5, 3.6
+- Django 1.7, 1.8, 1.9, 1.10, 1.11
+
+Installation
+------------
+
+- Run ``pip install django-admin-interface``
+- Add ``admin_interface``, ``flat_responsive``, ``flat`` *(only if django version < 1.9)* and ``colorfield`` to ``settings.INSTALLED_APPS`` **before** ``django.contrib.admin``
+- Run ``python manage.py migrate``
+- Run ``python manage.py collectstatic``
+- Restart your application server
+
+Upgrade
+^^^^^^^
+
+- Run ``pip install django-admin-interface --upgrade``
+- Run ``python manage.py migrate`` *(add* ``--fake-initial`` *if you are upgrading from 0.1.0 version)*
+- Run ``python manage.py collectstatic --clear``
+- Restart your application server
+
+Optional themes
+^^^^^^^^^^^^^^^
+
+This package ships with optional themes as fixtures, they can be
+installed using the ``loaddata`` admin command.
+Optional themes are activated on installation.
+
+**Django theme** (default):
+
+Run ``python manage.py loaddata admin_interface_theme_django.json``
+
+**Bootstrap theme**:
+
+Run ``python manage.py loaddata admin_interface_theme_bootstrap.json``
+
+**Foundation theme**:
+
+Run ``python manage.py loaddata admin_interface_theme_foundation.json``
+
+**U.S. Web Design Standards theme**:
+
+Run ``python manage.py loaddata admin_interface_theme_uswds.json``
+
+Add more themes
+^^^^^^^^^^^^^^^
+
+You can add a theme you've created through the admin to this repository
+by **sending us a PR**. Here are the steps to follow to add:
+
+1. Export your exact theme as fixture using the ``dumpdata`` admin command:
+``python manage.py dumpdata admin_interface.Theme --indent 4 -o admin_interface_theme_{{name}}.json --pks=N``
+
+2. Copy the generated json file into the fixtures folder *(making sure
+its name starts with ``admin_interface_theme_`` to avoid clashes with
+fixtures that might be provided by other third party apps)*.
+
+3. Remove the ``pk`` from the fixture and make sure the ``active``
+field is set to ``true`` *(in this way a theme is automatically
+activated when installed)*.
+
+4. Edit the section above to document your theme.
+
+Screenshots
+-----------
+
+Admin login
+
+
+|django-admin-interface_login|
+-------------------------------
+
+Admin dashboard
+
+
+|django-admin-interface_dashboard|
+-----------------------------------
+
+Admin themes management
+
+
+|django-admin-interface_themes_management|
+--------------------------------------------
+
+Admin theme customization
+
+
+|django-admin-interface_theme_customization|
+---------------------------------------------
+
+FAQ
+---
+
+**I already have a custom** ``base_site.html`` **, how can I make it work?**
+
+You can use ``django-apptemplates`, then add ``{% extends "admin_interface:admin/base_site.html" %}`` to your ``base_site.html``
+
+License
+-------
+
+Released under **MIT License**.
+
+
+.. |Build Status| image:: https://travis-ci.org/fabiocaccamo/django-admin-interface.svg?branch=master :target: https://travis-ci.org/fabiocaccamo/django-admin-interface
+
+.. |codecov| image:: https://codecov.io/gh/fabiocaccamo/django-admin-interface/branch/master/graph/badge.svg :target: https://codecov.io/gh/fabiocaccamo/django-admin-interface
+
+.. |Code Health| image:: https://landscape.io/github/fabiocaccamo/django-admin-interface/master/landscape.svg?style=flat :target: https://landscape.io/github/fabiocaccamo/django-admin-interface/master
+
+.. |PyPI version| image:: https://badge.fury.io/py/django-admin-interface.svg :target: https://badge.fury.io/py/django-admin-interface
+
+.. |Py versions| image:: https://img.shields.io/pypi/pyversions/django-admin-interface.svg :target: https://img.shields.io/pypi/pyversions/django-admin-interface.svg
+
+.. |License| image:: https://img.shields.io/pypi/l/django-admin-interface.svg :target: https://img.shields.io/pypi/l/django-admin-interface.svg
+
+.. |django-admin-interface_login| image:: https://cloud.githubusercontent.com/assets/1035294/11240233/55c8d4ba-8df1-11e5-9568-00fdc987ede8.gif
+
+.. |django-admin-interface_dashboard| image:: https://cloud.githubusercontent.com/assets/1035294/11240239/627c0362-8df1-11e5-81fa-216366a5d8da.gif
+
+.. |django-admin-interface_themes_management| image:: https://cloud.githubusercontent.com/assets/1035294/11240245/6cd1c342-8df1-11e5-928b-f22217474d3d.gif
+
+.. |django-admin-interface_theme_customization| image:: https://cloud.githubusercontent.com/assets/1035294/11240250/7350d942-8df1-11e5-9b28-f2f54c333cdc.gif

setup.py

@@ -4,14 +4,18 @@
 from setuptools import find_packages, setup
 
 import os
-import pypandoc
+# import pypandoc
 
 exec(open('admin_interface/version.py').read())
 
 github_url = 'https://github.com/fabiocaccamo'
 package_name = 'django-admin-interface'
 package_path = os.path.abspath(os.path.dirname(__file__))
-long_description = pypandoc.convert(os.path.join(package_path, 'README.md'), 'rst')
+# long_description = pypandoc.convert(os.path.join(package_path, 'README.md'), 'rst')
+long_description_file_path = os.path.join(package_path, 'README.rst')
+long_description = ''
+with open(long_description_file_path) as f:
+    long_description = f.read()
 
 setup(
     name=package_name,