Update docs/tech_docs/python/Python-Virtual-Environments.md

This commit is contained in:
2024-03-08 20:58:48 +00:00
parent 391f80d0b5
commit 953ee6f1c2

View File

@@ -118,6 +118,7 @@ In a Python project, particularly on a Debian Linux system, it's important to fo
By following this structure and these tips, you can maintain a well-organized and efficient development environment for your Python projects on Debian. By following this structure and these tips, you can maintain a well-organized and efficient development environment for your Python projects on Debian.
--- ---
# Setting Up a Virtual Environment for KnowledgeBase-Tech Hugo Site # Setting Up a Virtual Environment for KnowledgeBase-Tech Hugo Site
## Update PATH Environment Variable ## Update PATH Environment Variable
@@ -193,7 +194,6 @@ deactivate
## Working with the Environment ## Working with the Environment
Remember to activate the `KnowledgeBase-Tech_env` environment every time you work on the KnowledgeBase-Tech Hugo site. This ensures all dependencies are isolated to this specific project. Remember to activate the `KnowledgeBase-Tech_env` environment every time you work on the KnowledgeBase-Tech Hugo site. This ensures all dependencies are isolated to this specific project.
````
Replace `<package-name>` with the specific packages you need for your Hugo site. The addition of the freeze requirements section will help maintain a consistent set of dependencies across different development environments. Replace `<package-name>` with the specific packages you need for your Hugo site. The addition of the freeze requirements section will help maintain a consistent set of dependencies across different development environments.
@@ -244,7 +244,7 @@ deactivate
## Working with the Environment ## Working with the Environment
Remember to activate the `KnowledgeBase-Tech_env` environment every time you work on the KnowledgeBase-Tech Hugo site. This ensures all dependencies are isolated to this specific project. Remember to activate the `KnowledgeBase-Tech_env` environment every time you work on the KnowledgeBase-Tech Hugo site. This ensures all dependencies are isolated to this specific project.
```
Replace `<package-name>` with any specific Python package you need for your Hugo site. This guide will help you maintain a clean and isolated environment for your Hugo site development. Replace `<package-name>` with any specific Python package you need for your Hugo site. This guide will help you maintain a clean and isolated environment for your Hugo site development.
@@ -285,7 +285,6 @@ Replace `<package-name>` with any specific Python package you need for your Hugo
```bash ```bash
pip install mkdocs pip install mkdocs
``` ```
6. **Create Your Mkdocs Project:** 6. **Create Your Mkdocs Project:**
After Mkdocs is installed, you can create a new Mkdocs project: After Mkdocs is installed, you can create a new Mkdocs project:
```bash ```bash
@@ -625,6 +624,4 @@ When setting up a Python project with a virtual environment, organizing your pro
- It's created by running `pip freeze > requirements.txt` inside your activated virtual environment. - It's created by running `pip freeze > requirements.txt` inside your activated virtual environment.
- This file ensures that anyone who clones your project can install the exact same dependencies by running `pip install -r requirements.txt`. - This file ensures that anyone who clones your project can install the exact same dependencies by running `pip install -r requirements.txt`.
This structure is just a guideline and can be adjusted based on the specific needs of your project. The key is to keep it organized and logical to facilitate easy navigation and collaboration. This structure is just a guideline and can be adjusted based on the specific needs of your project. The key is to keep it organized and logical to facilitate easy navigation and collaboration.
---