<NME> README.rst
<BEF> README
======

About
-----

This sample project demonstrates how to use the debug toolbar. It is designed
to run under the latest stable version of Django.

It also provides a few test pages to ensure the debug toolbar doesn't
interfere with common JavaScript frameworks.

How to
------

The example project requires a working installation of Django::

    $ pip install Django

The following command must run from the root directory of Django Debug Toolbar,
i.e. the directory that contains ``example/``::

    $ make example

This will create a database, superuser, and run the Django development server.
The superuser's username will be the same as the current OS user and the
password is "p".

If you'd like to run these steps individually, use the following commands.
Again, run from the root directory of Django Debug Toolbar.

Create a database::

    $ python example/manage.py migrate

Create a superuser::

    $ python example/manage.py createsuperuser

Run the Django development server::

    $ python example/manage.py runserver

You can change the database used by specifying the ``DB_BACKEND``
environment variable::

    $ DB_BACKEND=postgresql python example/manage.py migrate
    $ DB_BACKEND=postgresql python example/manage.py runserver

<MSG> Merge remote-tracking branch 'origin/mk/python-m-pip'

* origin/mk/python-m-pip:
  Follow the recommendations and use python -m pip instead of pip

<DFF> @@ -15,7 +15,7 @@ How to
 
 The example project requires a working installation of Django::
 
-    $ pip install Django
+    $ python -m pip install Django
 
 The following command must run from the root directory of Django Debug Toolbar,
 i.e. the directory that contains ``example/``::

{'commit': "diff --git a/docs/contributing.rst b/docs/contributing.rst\nindex 9055112..c17dbd2 100644\n--- a/docs/contributing.rst\n+++ b/docs/contributing.rst\n@@ -32,7 +32,7 @@ you'll have to deactivate it for this repository::\n Once you've obtained a checkout, you should create a virtualenv_ and install\n the libraries required for working on the Debug Toolbar::\n \n-    $ pip install -r requirements_dev.txt\n+    $ python -m pip install -r requirements_dev.txt\n \n .. _virtualenv: https://virtualenv.pypa.io/\n \ndiff --git a/docs/installation.rst b/docs/installation.rst\nindex 0d5d210..b3ebbf7 100644\n--- a/docs/installation.rst\n+++ b/docs/installation.rst\n@@ -9,7 +9,7 @@ Getting the code\n \n The recommended way to install the Debug Toolbar is via pip_::\n \n-    $ pip install django-debug-toolbar\n+    $ python -m pip install django-debug-toolbar\n \n If you aren't familiar with pip, you may also obtain a copy of the\n ``debug_toolbar`` directory and add it to your Python path.\n@@ -19,7 +19,7 @@ If you aren't familiar with pip, you may also obtain a copy of the\n To test an upcoming release, you can install the in-development version\n instead with the following command::\n \n-     $ pip install -e git+https://github.com/jazzband/django-debug-toolbar.git#egg=django-debug-toolbar\n+     $ python -m pip install -e git+https://github.com/jazzband/django-debug-toolbar.git#egg=django-debug-toolbar\n \n Prerequisites\n -------------\ndiff --git a/example/README.rst b/example/README.rst\nindex 5a8a223..2b9f41f 100644\n--- a/example/README.rst\n+++ b/example/README.rst\n@@ -15,7 +15,7 @@ How to\n \n The example project requires a working installation of Django::\n \n-    $ pip install Django\n+    $ python -m pip install Django\n \n The following command must run from the root directory of Django Debug Toolbar,\n i.e. the directory that contains ``example/``::\n", 'commit_subject': "Merge remote-tracking branch 'origin/mk/python-m-pip'", 'repo_name': 'jazzband/django-debug-toolbar', 'committer': {'name': 'Matthias Kestenholz', 'email': 'a91dcbb4df49d8bfe0a9930d7ff911a4292ca1f5@feinheit.ch', 'time_sec': '1600668065', 'tz_offset': '120', 'date': {'seconds': '1600668065'}}, 'commit_tree': '70bf074c92896026aa68147f993cfe5120240593', 'commit_message': "Merge remote-tracking branch 'origin/mk/python-m-pip'\n\n* origin/mk/python-m-pip:\n  Follow the recommendations and use python -m pip instead of pip\n", 'language_name': 'JavaScript', 'license': 'bsd-3-clause', 'hunks': '@@ -15,7 +15,7 @@ How to\n \n The example project requires a working installation of Django::\n \n-    $ pip install Django\n+    $ python -m pip install Django\n \n The following command must run from the root directory of Django Debug Toolbar,\n i.e. the directory that contains ``example/``::\n', 'addition_count': 1, 'deletion_count': 1, 'src_file': 'a/example/README.rst', 'tgt_file': 'b/example/README.rst', 'file_extension': '.rst', 'before_file': 'README\n======\n\nAbout\n-----\n\nThis sample project demonstrates how to use the debug toolbar. It is designed\nto run under the latest stable version of Django.\n\nIt also provides a few test pages to ensure the debug toolbar doesn\'t\ninterfere with common JavaScript frameworks.\n\nHow to\n------\n\nThe example project requires a working installation of Django::\n\n    $ pip install Django\n\nThe following command must run from the root directory of Django Debug Toolbar,\ni.e. the directory that contains ``example/``::\n\n    $ make example\n\nThis will create a database, superuser, and run the Django development server.\nThe superuser\'s username will be the same as the current OS user and the\npassword is "p".\n\nIf you\'d like to run these steps individually, use the following commands.\nAgain, run from the root directory of Django Debug Toolbar.\n\nCreate a database::\n\n    $ python example/manage.py migrate\n\nCreate a superuser::\n\n    $ python example/manage.py createsuperuser\n\nRun the Django development server::\n\n    $ python example/manage.py runserver\n\nYou can change the database used by specifying the ``DB_BACKEND``\nenvironment variable::\n\n    $ DB_BACKEND=postgresql python example/manage.py migrate\n    $ DB_BACKEND=postgresql python example/manage.py runserver\n', 'message': "Merge remote-tracking branch 'origin/mk/python-m-pip'\n\n* origin/mk/python-m-pip:\n  Follow the recommendations and use python -m pip instead of pip\n", 'author_name': 'Matthias Kestenholz', 'lang': 'rst'}