Merge pull request #326 from gyermolenko/update_documentation

Update docs

Author: jettify

CONTRIBUTING.rst

@@ -1,6 +1,3 @@
-Contributing
-============
-
 Running Tests
 -------------
 
@@ -29,21 +26,32 @@ After that please install libraries required for development::
 
 Congratulations, you are ready to run the test suite::
 
-    $ py.test --dp -s -v ./tests
+    $ py.test -s -v ./tests
 
 Under the hood python docker client pulls images for PostgreSQL, MySQL
 and Mongodb. Fixtures start databases and insert testing data. You do not
 have to install any database at all.
 
-Next time  `--dp` (docker pull) flag could be dropped since all required
-images are cached on local machine. To make sure you have required images
-please execute::
+.. note::
+
+    If you have troubles running specified command, you may try this one
+    (from the project root folder)::
+
+        $ python -m pytest -s -v ./tests
+
+    More information `here <https://docs.pytest.org/en/latest/usage.html#cmdline>`_.
+
+Next time you can add `--no-pull` flag since all required images are present::
+
+    $ py.test --no-pull -s -v ./tests
+
+To make sure you have required images please execute::
 
     $ docker images
 
 Among results you should find something like::
 
-    postgres  9.5  247a11721cbd  2 weeks ago  265.9 MB
+    postgres  9.6  247a11721cbd  2 weeks ago  265.9 MB
     mysql     5.7  63a92d0c131d  8 weeks ago  374.1 MB
     mongo     2.6  150dd5b5bd1b  9 weeks ago  390.9 MB
 

README.rst

@@ -32,52 +32,7 @@ Design
     :scale: 60 %
 
 
-Run Tests
----------
-Fist of all just clone repository::
-
-    $ git clone [email protected]:aio-libs/aiohttp_admin.git
-
-Install docker_ using instruction_ from the official site, for OSX we
-use docker-machine_.
-
-Create virtualenv with python3.5 (older version are not supported). For example
-using *virtualenvwrapper* commands could look like::
-
-   $ cd aiohttp_admin
-   $ mkvirtualenv --python=`which python3.5` aiohttp_admin
-
-
-After that please install libraries required for development::
-
-   $ pip install -r requirements-dev.txt
-
-Congratulations, you are ready to run the test suite::
-
-    $ py.test --dp -s -v ./tests
-
-Under the hood python docker client pulls images for PostgreSQL, MySQL
-and Mongodb. Fixtures start databases and insert testing data. You do not
-have to install any database at all.
-
-Next time  `--dp` (docker pull) flag could be dropped since all required
-images are cached on local machine. To make sure you have required images
-please execute::
-
-    $ docker images
-
-Among results you should find something like::
-
-    postgres  9.5  247a11721cbd  2 weeks ago  265.9 MB
-    mysql     5.7  63a92d0c131d  8 weeks ago  374.1 MB
-    mongo     2.6  150dd5b5bd1b  9 weeks ago  390.9 MB
-
-
-For OSX users one extra step is required, before running tests, please
-init environment variables::
-
-    $ eval $(docker-machine env default)
-    $ export DOCKER_MACHINE_IP=$(docker-machine ip)
+.. include:: CONTRIBUTING.rst
 
 
 Supported backends

demos/polls/aiohttpdemo_polls/main.py

@@ -52,7 +52,7 @@ async def close_pg(app):
     # setup admin views
     admin_config = str(PROJ_ROOT / 'static' / 'js')
     admin = setup_admin(app, pg, admin_config)
-    app.router.add_subapp('/admin', admin)
+    app.add_subapp('/admin', admin)
 
     app.on_cleanup.append(close_pg)
 

demos/polls/aiohttpdemo_polls/templates/index.html

@@ -4,7 +4,7 @@
 {% if questions %}
     <ul>
     {% for question in questions %}
-    <li><a href="{{ url('poll', parts={'question_id': question.id}) }}">{{ question.question_text }}</a></li>
+    <li><a href="{{ url('poll', question_id=question.id) }}">{{ question.question_text }}</a></li>
     {% endfor %}
     </ul>
 {% else %}

docker-compose.yml

@@ -1,6 +1,5 @@
 postgres:
-    image: postgres:9.5
-    environment:
+    image: postgres:9.6
     environment:
         - POSTGRES_USER=aiohttp_admin_user
         - POSTGRES_PASSWORD=mysecretpassword

tests/docker_fixtures.py

@@ -15,7 +15,7 @@
 
 def pytest_addoption(parser):
     parser.addoption("--no-pull", action="store_true", default=False,
-                     help=("Force docker pull"))
+                     help=("Do not pull docker images"))
 
 
 @pytest.fixture(scope='session')