11
22.. raw :: html
3-
3+
44 <h1 align =" center" >
55 <img width =" 400" src =" https://i.imgur.com/79S6OVM.png" alt =" django-postgres-extra" >
66 <br >
77 <br >
8- </h1 >
8+ </h1 >
99
10- ================= ===================
10+ ==================== ===================
1111**Quality ** |QualityBadge |_
1212**Test coverage ** |CoverageBadge |_
1313**License ** |LicenseBadge |_
1414**PyPi ** |PyPiBadge |_
15- ================= ===================
15+ **Django versions ** >=1.11 (including 2.0)
16+ **Python versions ** >=3.5
17+ ==================== ===================
1618
1719.. |QualityBadge | image :: https://scrutinizer-ci.com/g/SectorLabs/django-postgres-extra/badges/quality-score.png
1820.. _QualityBadge : https://scrutinizer-ci.com/g/SectorLabs/django-postgres-extra/
@@ -37,7 +39,7 @@ Documentation
3739-------------
3840
3941* **ReadTheDocs HTML **
40-
42+
4143 http://django-postgres-extra.readthedocs.io
4244
4345* **Plain MarkDown **
@@ -53,7 +55,7 @@ Major features
5355 * Concurrency safe
5456 * With bulk support (single query)
5557
56- 2. **Extended support for `` HStoreField`` **
58+ 2. **Extended support for HStoreField **
5759
5860 * Unique constraints
5961 * Null constraints
@@ -126,9 +128,9 @@ FAQ - Frequently asked questions
126128
127129 No. Only Python 3.5 or newer is supported. We're using type hints. These do not work well under older versions of Python.
128130
129- 4. **Does this package work with Django 1.X ? **
131+ 4. **Which Django versions does this package work with? **
130132
131- No. Only Django 1.11 or newer is supported .
133+ Django 1.11 or newer (that includes Django 2.0) .
132134
133135
134136Working with the code
@@ -145,31 +147,42 @@ Working with the code
1451471. Clone the repository:
146148
147149 .. code-block :: bash
148-
150+
149151 λ git clone https://github.com/SectorLabs/django-postgres-extra.git
150152
151153 2. Create a virtual environment:
152154
153155 .. code-block :: bash
154-
156+
155157 λ cd django-postgres-extra
156158 λ virtualenv env
157159 λ source env/bin/activate
158160
159- 3. Install the development/test dependencies:
161+ 3. Create a postgres user for use in tests (skip if your default user is a postgres superuser):
162+
163+ .. code-block :: bash
164+
165+ λ createuser --superuser psqlextra --pwprompt
166+ λ export DATABASE_URL=postgres://psqlextra:< password> @localhost/psqlextra
167+
168+ Hint: if you're using virtualenvwrapper, you might find it beneficial to put
169+ the ``export `` line in ``$VIRTUAL_ENV/bin/postactivate `` so that it's always
170+ available when using this virtualenv.
171+
172+ 4. Install the development/test dependencies:
160173
161174 .. code-block :: bash
162-
175+
163176 λ pip install -r requirements/test.txt
164-
165- 4 . Run the tests:
177+
178+ 5 . Run the tests:
166179
167180 .. code-block :: bash
168-
169- λ py.test
170-
171- 5 . Run the benchmarks:
181+
182+ λ tox
183+
184+ 6 . Run the benchmarks:
172185
173186 .. code-block :: bash
174-
187+
175188 λ py.test -c pytest-benchmark.ini
0 commit comments