Skip to content
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.

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

Update Technology section #33

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
87 changes: 83 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes feels unnecessary and doesn't add any value in particular.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, no worries. I found questions that people ask for the setup of the Python environment in which dependencies should not mess up with Python on the system, especially on Linux where dependencies are built on the top of it. Setting up a virtual environment helps to avoid this mess. However, I'll drop the changes. Thanks.

$ 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 [email protected]: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
```
25 changes: 24 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -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