From 434bc98ececfe9f5101c2a63de1c36376acbafc6 Mon Sep 17 00:00:00 2001 From: ramlaxman <1982225+ramlaxman@users.noreply.github.com> Date: Fri, 31 May 2024 22:52:37 +0530 Subject: [PATCH 1/2] Update README for Setup --- README.md | 87 +++++++++++++++++++++++++++++++++++++++++++++--- requirements.txt | 25 +++++++++++++- 2 files changed, 107 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 22d0f61..41cd807 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,91 @@ Theme used: [Furo](https://pradyunsg.me/furo/quickstart/) Setup local environment and install dependencies from `requirements.txt`. -Build files: +1. Create and enter in a directory called `Pycon-work`: ```sh -make html +$ mkdir Pycon-work +$ cd Pycon-work ``` -## Run locally: +2. Install virtual environment: -Run `daemon.sh` for reload support while developing. +```sh +$ pip install virtualenv +``` + +3. Create the `test-env` virtual environment: + +```sh +$ python3.12 -m venv test-env +``` + +4. Activate the virtual environment: + +```sh +$ source test-env/bin/activate +``` + +5. Clone git directory: + +```sh +$ git clone git@github.com:pythonindia/navigator.git +``` +6. Enter in the directotry: + +```sh +$ cd navigator/ +``` +7. Create a new branch for your contriution: + +```sh +$ git checkout -b example-branch +``` + +8. Switch to the created branch: + +```sh +$ git switch cfp-issue-22 +``` + +9. Upgrade `pip` package: +```sh +$ pip install --upgrade pip +``` + +10. Install from `requirements.txt`: + +```sh +$ pip install -r requirements.txt +``` + +11. Check the list of installed python packages: + +```sh +$ pip list +``` + +12. Freeze the python pacakges versions: + +```sh +$ pip freeze > requirements.txt +``` + +13. Build locally to maintain groups of programs and files from the source code: + +```sh +$ make html +``` + +14. Run python HTTP server: + +```sh +$ ./daemon.sh +``` +> Use `Ctrl+C` to shutdown the server. + +15. Deactive the virtual environment when not in use: + +```sh +$ deactivate +``` diff --git a/requirements.txt b/requirements.txt index f978b4d..3293b17 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,25 @@ -Sphinx==7.2.6 +alabaster==0.7.16 +Babel==2.15.0 +beautifulsoup4==4.12.3 +certifi==2024.2.2 +charset-normalizer==3.3.2 +docutils==0.20.1 furo==2024.5.6 +idna==3.7 +imagesize==1.4.1 +Jinja2==3.1.4 +MarkupSafe==2.1.5 +packaging==24.0 +Pygments==2.18.0 +requests==2.32.2 +snowballstemmer==2.2.0 +soupsieve==2.5 +Sphinx==7.2.6 +sphinx-basic-ng==1.0.0b2 +sphinxcontrib-applehelp==1.0.8 +sphinxcontrib-devhelp==1.0.6 +sphinxcontrib-htmlhelp==2.0.5 +sphinxcontrib-jsmath==1.0.1 +sphinxcontrib-qthelp==1.0.7 +sphinxcontrib-serializinghtml==1.1.10 +urllib3==2.2.1 From 07d69e81f811f05042a31827ad0be792e45c3b01 Mon Sep 17 00:00:00 2001 From: ramlaxman <1982225+ramlaxman@users.noreply.github.com> Date: Sat, 8 Jun 2024 22:48:44 +0530 Subject: [PATCH 2/2] Dropped changes as per comment --- README.md | 87 +++---------------------------------------------------- 1 file changed, 4 insertions(+), 83 deletions(-) diff --git a/README.md b/README.md index 41cd807..22d0f61 100644 --- a/README.md +++ b/README.md @@ -10,91 +10,12 @@ Theme used: [Furo](https://pradyunsg.me/furo/quickstart/) Setup local environment and install dependencies from `requirements.txt`. -1. Create and enter in a directory called `Pycon-work`: +Build files: ```sh -$ mkdir Pycon-work -$ cd Pycon-work +make html ``` -2. Install virtual environment: +## Run locally: -```sh -$ pip install virtualenv -``` - -3. Create the `test-env` virtual environment: - -```sh -$ python3.12 -m venv test-env -``` - -4. Activate the virtual environment: - -```sh -$ source test-env/bin/activate -``` - -5. Clone git directory: - -```sh -$ git clone git@github.com:pythonindia/navigator.git -``` -6. Enter in the directotry: - -```sh -$ cd navigator/ -``` -7. Create a new branch for your contriution: - -```sh -$ git checkout -b example-branch -``` - -8. Switch to the created branch: - -```sh -$ git switch cfp-issue-22 -``` - -9. Upgrade `pip` package: -```sh -$ pip install --upgrade pip -``` - -10. Install from `requirements.txt`: - -```sh -$ pip install -r requirements.txt -``` - -11. Check the list of installed python packages: - -```sh -$ pip list -``` - -12. Freeze the python pacakges versions: - -```sh -$ pip freeze > requirements.txt -``` - -13. Build locally to maintain groups of programs and files from the source code: - -```sh -$ make html -``` - -14. Run python HTTP server: - -```sh -$ ./daemon.sh -``` -> Use `Ctrl+C` to shutdown the server. - -15. Deactive the virtual environment when not in use: - -```sh -$ deactivate -``` +Run `daemon.sh` for reload support while developing.