diff --git a/docs/Utilities/venv-manager.md b/docs/Utilities/venv-manager.md deleted file mode 100644 index d635283..0000000 --- a/docs/Utilities/venv-manager.md +++ /dev/null @@ -1,42 +0,0 @@ -# venv-manager: -A utility for creating, deleting and reseting virtual environments for webqueue2's API. - -!!! note - All of the commands and code examples in this document assumes you're running on either RHEL, CentOS or Ubuntu inside a bash shell. If you're using a different environment, some commads and code examples might now work. - -## Getting Started with Python Virtual Environments -The webqueue2 API is written in Python 3 and utilizes Python virtual environments for containment and reliability. Virtual environments are localized installations of a Python interpeter that allow for the installation of Python packages that are different in version from the global Python installation and/or the installation of Python packages that aren't installed globally. - -### Createing a Python 3 Virtual Environment - -Virtual environments enable you to have an isolated space on your server for Python projects, ensuring that each of your projects can have its own set of dependencies that won’t disrupt any of your other projects. - -Setting up a programming environment provides us with greater control over our Python projects and over how different versions of packages are handled. This is especially important when working with third-party packages. - -You can set up as many Python programming environments as you want. Each environment is basically a directory or folder on your server that has a few scripts in it to make it act as an environment. - -While there are a few ways to achieve a programming environment in Python, we’ll be using the venv module here, which is part of the standard Python 3 library. - -You can create an environment called `my_env` by running the following command: - -```bash -python3 -m venv my_env -``` - -### Using a Python Virtual Environment - -To use this environment, you need to activate it, which you can achieve by typing the following command that calls the activate script: - -```bash -source my_env/bin/activate -``` - -Your command prompt will now be prefixed with the name of your environment in parenthesis, in this case it is called my_env. - -``` -(my_env) campb303@pier [~] -$ -``` - -!!! note - While inside the virtual environment you can use `python` and `python3` interchangably. When outside the environment, you must use `python3` or you will likely call Python 2. \ No newline at end of file