From f4f30256e2f1f8bcaa6f21d42dd68bbb6948d58f Mon Sep 17 00:00:00 2001 From: za Date: Wed, 25 May 2022 20:35:19 +0700 Subject: [PATCH 1/4] Updated README.rst to include how to do the setup --- README.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.rst b/README.rst index 77f11e19..f5b48bb8 100644 --- a/README.rst +++ b/README.rst @@ -41,6 +41,29 @@ If a Python core developer approved a PR made by anyone and added the "🤖 auto it will be automatically merged once all the CI checks pass. +Setup Info +========== + +Requires Python 3.6+ + +``` +$ python3 -m venv venv +$ source venv/bin/activate + +// for development +(venv) $ pip install -r dev-requirements.txt + +// for production +(venv) $ pip install -r dev-requirements.txt + +``` + +Run the test code: +``` +(venv) $ pytest + +``` + **Aside**: where does the name come from? ========================================= From 40b9c8fad24e4ed94ca0ede164b69684f93abdd3 Mon Sep 17 00:00:00 2001 From: za Date: Thu, 26 May 2022 19:05:03 +0700 Subject: [PATCH 2/4] Updated formatting using rst format --- README.rst | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index f5b48bb8..9646a701 100644 --- a/README.rst +++ b/README.rst @@ -46,23 +46,20 @@ Setup Info Requires Python 3.6+ -``` -$ python3 -m venv venv -$ source venv/bin/activate +Create virtual environment and activate it: +.. code-block:: shell + $ python3 -m venv venv + $ source venv/bin/activate -// for development -(venv) $ pip install -r dev-requirements.txt - -// for production -(venv) $ pip install -r dev-requirements.txt - -``` +Install development or production dependencies: +.. code-block:: shell + (venv) $ pip install -r dev-requirements.txt # for development + (venv) $ pip install -r requirements.txt # for production Run the test code: -``` -(venv) $ pytest +.. code-block:: shell + (venv) $ pytest -``` **Aside**: where does the name come from? ========================================= From c3f71d79488b92ec10f73af1c89853bc9238ad1f Mon Sep 17 00:00:00 2001 From: za Date: Thu, 26 May 2022 19:25:01 +0700 Subject: [PATCH 3/4] Used :: for commands reference: https://devguide.python.org/documenting/#showing-code-examples --- README.rst | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 9646a701..fc30b20c 100644 --- a/README.rst +++ b/README.rst @@ -46,20 +46,19 @@ Setup Info Requires Python 3.6+ -Create virtual environment and activate it: -.. code-block:: shell - $ python3 -m venv venv - $ source venv/bin/activate +Create virtual environment and activate it:: -Install development or production dependencies: -.. code-block:: shell - (venv) $ pip install -r dev-requirements.txt # for development - (venv) $ pip install -r requirements.txt # for production + $ python3 -m venv venv + $ source venv/bin/activate -Run the test code: -.. code-block:: shell - (venv) $ pytest +Install development or production dependencies:: + (venv) $ pip install -r dev-requirements.txt # for development + (venv) $ pip install -r requirements.txt # for production + +Run the test code:: + + (venv) $ pytest **Aside**: where does the name come from? ========================================= From 1df188e6a0b323d5d16ba63b7d865ba9135ba81e Mon Sep 17 00:00:00 2001 From: za Date: Mon, 18 Jul 2022 12:14:54 +0700 Subject: [PATCH 4/4] Add highlight shell Co-authored-by: Ezio Melotti --- README.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.rst b/README.rst index fc30b20c..e7651ef2 100644 --- a/README.rst +++ b/README.rst @@ -44,6 +44,8 @@ it will be automatically merged once all the CI checks pass. Setup Info ========== +.. highlight:: shell + Requires Python 3.6+ Create virtual environment and activate it::