Skip to content

Update docs with current packages & versions #575

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
akatsoulas merged 2 commits into from
Jan 7, 2026
Merged

Update docs with current packages & versions #575

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d25e5e2
Update readme instructions
janbrasna Dec 19, 2025
1230d90
Remove unused overview pages from index
janbrasna Dec 19, 2025
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
26 changes: 13 additions & 13 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
mozilla-django-oidc
===================

.. image:: https://badge.fury.io/py/mozilla-django-oidc.svg
:target: https://badge.fury.io/py/mozilla-django-oidc
.. image:: https://img.shields.io/pypi/v/mozilla-django-oidc
:target: https://pypi.org/project/mozilla-django-oidc/

.. image:: https://github.com/mozilla/mozilla-django-oidc/actions/workflows/unit_tests.yml/badge.svg?branch=main
:target: https://github.com/mozilla/mozilla-django-oidc/actions/workflows/unit_tests.yml
Expand Down Expand Up @@ -40,7 +40,7 @@ Running Unit Tests

Use ``tox`` to run as many different versions of Python you have. If you
don't have ``tox`` installed (and executable) already you can either
install it in your system Python or `<https://pypi.python.org/pypi/pipsi>`_.
install it in your system Python or use `pipx <https://pipx.pypa.io/>`_.
Once installed, simply execute in the project root directory.

.. code-block:: shell
Expand All @@ -49,7 +49,7 @@ Once installed, simply execute in the project root directory.

``tox`` will do the equivalent of installing virtual environments for every
combination mentioned in the ``tox.ini`` file. If your system, for example,
doesn't have ``python3.4`` those ``tox`` tests will be skipped.
doesn't have ``python3.10`` those ``tox`` tests will be skipped.

For a faster test-rinse-repeat cycle you can run tests in a specific
environment with a specific version of Python and specific version of
Expand All @@ -75,7 +75,7 @@ Local development
The local development setup is based on Docker so you need the following installed in your system:

* `docker`
* `docker-compose`
* `docker compose`

You will also need to edit your ``hosts`` file to resolve ``testrp`` and ``testprovider`` hostnames to ``127.0.0.1``.

Expand All @@ -86,7 +86,7 @@ To run the `testrp` and `testprovider` instances run the following:

.. code-block:: shell

(venv) $ docker-compose up -d testprovider testrp
(venv) $ docker compose up -d testprovider testrp

Then visit the testing django app on: ``http://testrp:8081``.

Expand All @@ -95,8 +95,8 @@ In order to test a change you need to restart the ``testrp`` service.

.. code-block:: shell

(venv) $ docker-compose stop testrp
(venv) $ docker-compose up -d testrp
(venv) $ docker compose stop testrp
(venv) $ docker compose up -d testrp

Running integration tests
=========================
Expand All @@ -105,12 +105,12 @@ Integration tests are mounted as a volume to the docker containers. Tests can be

.. code-block:: shell

(venv) $ docker-compose run --service-ports testrunner
(venv) $ docker compose run --service-ports testrunner

Linting
-------

All code is checked with `<https://pypi.python.org/pypi/flake8>`_ in
All code is checked with `flake8 <https://pypi.org/project/flake8/>`_ in
continuous integration. To make sure your code still passes all style guides
install ``flake8`` and check:

Expand Down Expand Up @@ -139,7 +139,7 @@ Finally you can use pre-commit hooks to run linting and formatting before you co
Releasing a new version
------------------------

``mozilla-django-oidc`` releases are hosted in `PyPI <https://pypi.python.org/pypi/mozilla-django-oidc>`_.
``mozilla-django-oidc`` releases are hosted in `PyPI <https://pypi.org/project/mozilla-django-oidc/>`_.
Here are the steps you need to follow in order to push a new release:

* Make sure that ``HISTORY.rst`` is up-to-date focusing mostly on backwards incompatible changes.
Expand Down Expand Up @@ -181,7 +181,7 @@ Here are the steps you need to follow in order to push a new release:

git push origin 0.1.1

The release is pushed automatically to PyPI using a travis deployment hook on every new tag.
The release is published automatically to PyPI using GitHub Actions on every new tag.


License
Expand All @@ -198,5 +198,5 @@ Tools used in rendering this package:
* Cookiecutter_
* `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage
2 changes: 0 additions & 2 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,3 @@ Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`