Fix-up docs and remove unnecessary stuff.

simonpercivall · simonpercivall · commit af6a47dd9488 · 2015-08-12T23:56:13.000+02:00
diff --git a/.travis.yml b/.travis.yml
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -60,8 +60,7 @@ Ready to contribute? Here's how to set up `django_dbshell_plus` for local develo
 
 5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
 
-    $ flake8 django_dbshell_plus tests
-    $ python setup.py test
+    $ flake8 django_dbshell_plus
     $ tox
 
    To get flake8 and tox, just pip install them into your virtualenv. 
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -5,10 +5,10 @@ Changelog
 Here's the recent changes to Django DB Shell Plus.
 
 .. changelog::
-    :version: dev
-    :released: Ongoing
+    :version: 1.0.1
+    :released: 2015-08-12
 
     .. change::
-        :tags: docs
+        :tags: general
 
-        Updated CHANGES.
+        Initial version, use `pgcli` or `mycli` when available.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -4,4 +4,3 @@ include HISTORY.rst
 include LICENSE
 include README.rst
 include requirements.txt
-include test_requirements.txt
diff --git a/Makefile b/Makefile
@@ -4,13 +4,12 @@ help:
 	@echo "clean-build - remove build artifacts"
 	@echo "clean-pyc - remove Python file artifacts"
 	@echo "lint - check style with flake8"
-	@echo "test - run tests"
 	@echo "coverage - check code coverage quickly with the default Python"
 	@echo "docs - generate Sphinx HTML documentation, including API docs"
 	@echo "release - package and upload a release"
 	@echo "sdist - package"
 
-clean: clean-build clean-pyc
+clean: clean-build clean-pyc clean-docs
 	rm -fr htmlcov/
 
 clean-build:
@@ -27,13 +26,7 @@ clean-docs:
 	rm -f docs/django_dbshell_plus*.rst
 
 lint:
-	flake8 lib/django_dbshell_plus tests
-
-test:
-	tox
-
-coverage:
-	tox -e coverage
+	flake8 lib/django_dbshell_plus
 
 docs:
 	tox -e docs
diff --git a/README.rst b/README.rst
@@ -2,23 +2,15 @@
 Django DB Shell Plus
 ====================
 
-.. This is an example of how the readme could be decorated with badges.
-    .. image:: https://badge.fury.io/py/django_dbshell_plus.png
-        :target: http://badge.fury.io/py/django_dbshell_plus
 
-    .. image:: https://travis-ci.org/<your github username>/django_dbshell_plus.png?branch=master
-        :target: https://travis-ci.org/<your github username>/django_dbshell_plus
+.. image:: https://badge.fury.io/py/django_dbshell_plus.png
+    :target: http://badge.fury.io/py/django-dbshell-plus
 
-    .. image:: https://pypip.in/d/django_dbshell_plus/badge.png
-        :target: https://crate.io/packages/django_dbshell_plus?version=latest
+.. image:: https://pypip.in/d/django_dbshell_plus/badge.png
+    :target: https://crate.io/packages/django-dbshell-plus?version=latest
 
 
-A dbshell_plus management command for Django that selects pgcli or mycli when available.
+A dbshell_plus management command for Django that selects `pgcli` or `mycli` when available.
 
 * Free software: BSD license
-* Documentation: http://django_dbshell_plus.rtfd.org.
-
-Features
---------
-
-* TODO
+* Documentation: http://django-dbshell-plus.rtfd.org.
diff --git a/docs/django_dbshell_plus.rst b/docs/django_dbshell_plus.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -12,7 +12,6 @@ Contents:
 
    installation
    usage
-   django_dbshell_plus
    contributing
    authors
    history
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -4,9 +4,5 @@ Installation
 
 At the command line::
 
-    $ easy_install django_dbshell_plus
-
-Or, if you have virtualenvwrapper installed::
-
-    $ mkvirtualenv django_dbshell_plus
     $ pip install django_dbshell_plus
+
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -2,6 +2,7 @@
 Usage
 =====
 
-To use Django DB Shell Plus in a project::
+Add `django_dbshell_plus` to installed apps in `settings.py`, then run::
+
+    > ./manage.py dbshell_plus
 
-	import django_dbshell_plus
diff --git a/setup.cfg b/setup.cfg
@@ -1,2 +1,5 @@
 [wheel]
 universal = 1
+
+[flake8]
+max_line_length = 90
diff --git a/setup.py b/setup.py
@@ -49,5 +49,4 @@ def read_version():
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.3',
     ],
-    test_suite='tests',
 )
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/test_django_dbshell_plus.py b/tests/test_django_dbshell_plus.py
