@@ -62,11 +62,14 @@ Ready to contribute? Here's how to set up `mozilla-django-oidc` for local develo
6262
6363 $ git clone git@github.com:your_name_here/mozilla-django-oidc.git
6464
65- 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
65+ 3. Create a virtual environment and install the package with its
66+ development dependencies. This command will install all the tools
67+ needed for testing and linting::
6668
67- $ mkvirtualenv mozilla-django-oidc
6869 $ cd mozilla-django-oidc/
69- $ python setup.py develop
70+ $ python -m venv .venv
71+ $ source .venv/bin/activate # On Windows use `.venv\Scripts\activate`
72+ $ pip install -e .[dev]
7073
71744. Create a branch for local development::
7275
@@ -77,12 +80,10 @@ Ready to contribute? Here's how to set up `mozilla-django-oidc` for local develo
77805. When you're done making changes, check that your changes pass flake8 and the
7881 tests, including testing other Python versions with tox::
7982
80- $ flake8 mozilla_django_oidc tests
81- $ python setup.py test
83+ $ make lint
84+ $ make test
8285 $ tox
8386
84- To get flake8 and tox, just pip install them into your virtualenv.
85-
86876. Make sure you update ``HISTORY.rst `` with your changes in the following categories
8788
8889 * Backwards-incompatible changes
@@ -106,9 +107,9 @@ Before you submit a pull request, check that it meets these guidelines:
1061072. If the pull request adds functionality, the docs should be updated. Put
107108 your new functionality into a function with a docstring, and add the
108109 feature to the list in README.rst.
109- 3. The pull request should work for Python 3.6+ and for PyPy . Check
110- `<https://github.com/mozilla/mozilla-django-oidc/actions >`_
111- and make sure that the tests pass for all supported Python versions.
110+ 3. The pull request should work for Python 3.8+ . Check
111+ `<https://github.com/mozilla/mozilla-django-oidc/actions >`_ and make sure
112+ that the tests pass for all supported Python versions.
112113
113114Tips
114115----
@@ -120,14 +121,14 @@ We use tox to run tests::
120121
121122To run a specific environment, use the ``-e `` argument::
122123
123- $ tox -e py27-django111
124+ $ tox -e py312-django420
124125
125126
126127You can also run the tests in a virtual environment without tox::
127128
128- $ DJANGO_SETTINGS_MODULE=tests.settings django-admin test
129+ $ make test
129130
130131
131132You can specify test modules to run rather than the whole suite::
132133
133- $ DJANGO_SETTINGS_MODULE=tests.settings django-admin test tests.test_views
134+ $ DJANGO_SETTINGS_MODULE=tests.settings python -m django test tests.test_views
0 commit comments