Skip to content

Add db setup info to README #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 28, 2018
Merged

Add db setup info to README #47

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
abaaae4
Indentation
PeterJCLaw Jan 28, 2018
22b1707
Explain how to configure a specific postgres user
PeterJCLaw Jan 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<img width="400" src="https://i.imgur.com/79S6OVM.png" alt="django-postgres-extra">
<br>
<br>
</h1>
</h1>

==================== ===================
**Quality** |QualityBadge|_
Expand Down Expand Up @@ -158,19 +158,30 @@ Working with the code
λ virtualenv env
λ source env/bin/activate

3. Install the development/test dependencies:
3. Create a postgres user for use in tests (skip if your default user is a postgres superuser):

.. code-block:: bash

λ createuser --superuser psqlextra --pwprompt
λ export DATABASE_URL=postgres://psqlextra:<password>@localhost/psqlextra

Hint: if you're using virtualenvwrapper, you might find it beneficial to put
the ``export`` line in ``$VIRTUAL_ENV/bin/postactivate`` so that it's always
available when using this virtualenv.

4. Install the development/test dependencies:

.. code-block:: bash

λ pip install -r requirements/test.txt

4. Run the tests:
5. Run the tests:

.. code-block:: bash

λ tox

5. Run the benchmarks:
6. Run the benchmarks:

.. code-block:: bash

Expand Down