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

Created and installed Virtual environment #6

Merged
merged 2 commits into from
Dec 12, 2023
Merged

Created and installed Virtual environment #6

merged 2 commits into from
Dec 12, 2023

Conversation

Dozie2001
Copy link
Contributor

Added virtual environment to the dependencies so that packages installed are set in one place. A virtual environment in Python is a self-contained directory that contains its own Python interpreter and libraries, separate from the system's Python interpreter. It is a way to create isolated environments for different Python projects, each with its own dependencies, packages, and Python version. Here are some key reasons for using virtual environments:

  • Isolation: Virtual environments allow you to create isolated environments for different projects. This means that the dependencies installed in one virtual environment do not affect other environments or the system's Python installation. This helps prevent conflicts between different project requirements.

  • Dependency Management: When working on multiple projects, each project may have different dependencies or require specific versions of libraries. Virtual environments enable you to manage and install project-specific dependencies without interfering with other projects or the system-wide Python environment.

  • Version Compatibility: Some projects may require a specific version of Python. Virtual environments make it easy to use different Python versions for different projects. This ensures that each project runs on the desired Python interpreter without affecting the system's default Python version.

  • Sandboxing: Virtual environments provide a sandboxed environment where you can experiment with different packages, libraries, and configurations without affecting your system-wide Python installation. This is particularly useful for testing or trying out new packages.

  • Cleaner Development and Deployment: When you share your code with others or deploy your application, using a virtual environment ensures that the required dependencies are clearly defined. This makes it easier for collaborators to set up the same environment and avoids issues related to different dependency versions.

Also made adjustments to README to show the steps needed when setting up the virtual environment

Copy link
Owner

@vantage-ola vantage-ola left a comment

Choose a reason for hiding this comment

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

good job dozie, but consider the review and make changes to them so i can approve asap!

.gitignore Outdated
@@ -86,6 +86,7 @@ ipython_config.py
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version
env
Copy link
Owner

Choose a reason for hiding this comment

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

if you check, line 122...all the possible environment files are in the .gitignore file.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok thank my bad on that

README.md Outdated
3. To access the mongo db database to run the flask api , create a local environment `/backend/.env` and copy the variables.(READ_ACCESS_ONLY)
3. Install dependencies:
```shell
pip3 install DEPENDENCIES.txt
Copy link
Owner

Choose a reason for hiding this comment

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

100% i approve of this

README.md Outdated
pip3 install DEPENDENCIES.txt
```

4. Create and activate virtualenvironment.
Copy link
Owner

Choose a reason for hiding this comment

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

creating a virtual env should come first before installing dependencies... this should be no 3, then installing dependencies should be no 4...you can also add installation for windows users also ...

like

  • On Windows:

    .\venv\Scripts\activate
  • On macOS and Linux:

    source venv/bin/activate

DEPENDENCIES.txt Outdated
@@ -1,10 +1,14 @@
blinker==1.7.0
click==8.1.7
distlib==0.3.8
Copy link
Owner

Choose a reason for hiding this comment

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

what do these packages do?

@vantage-ola vantage-ola added the good first issue Good for newcomers label Dec 12, 2023
@vantage-ola vantage-ola merged commit fd78e37 into vantage-ola:main Dec 12, 2023
@Dozie2001 Dozie2001 deleted the feature/read_me branch December 12, 2023 23:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants