From dd2a19c2cb92cdd9321363314616ce0e8ec979b5 Mon Sep 17 00:00:00 2001 From: Michael Schlenker Date: Thu, 31 Oct 2019 18:16:21 +0100 Subject: [PATCH] Update README.rst Add some basic instructions for Windows. --- README.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.rst b/README.rst index 1428e766a..02da956b5 100644 --- a/README.rst +++ b/README.rst @@ -106,3 +106,22 @@ a good place to start if you want to contribute. .. _our issues: https://github.com/OpenIDC/pyoidc/issues .. _newcomer-friendly: https://github.com/OpenIDC/pyoidc/issues?q=is%3Aopen+is%3Aissue+label%3Anewcomer-friendly + +Windows +------- + +If you happen to work in a Windows environment, the above will not work out of the box due to the lack +of a ``GNU Make`` on Windows. In addition one of the dependencies for ``ldap_authn`` is not available as a prebuilt +wheel from pypi, so use these slightly modified instructions. + +With :command:`pipenv` in your path you run: + +.. code:: console + + pipenv install --dev -e .[develop,testing,docs,quality] + +Next you can run the tests: + +.. code:: console + + pipenv run pytest tests