mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
cbbb9d9b9b
* Exclude include files from being built * Split install guides into multiple documents (one per OS/version combo) * Update references * Unify anchor names * Update pyenv requirements in CentOS 7 guide * Update install guides for RHEL derivatives to not use pyenv * Add guide for Rocky Linux 8 * 8.4+ -> 8.4-8.x * Add 'the'
45 lines
1.3 KiB
ReStructuredText
45 lines
1.3 KiB
ReStructuredText
------------------------------
|
|
Creating a Virtual Environment
|
|
------------------------------
|
|
|
|
.. tip::
|
|
|
|
If you want to learn more about virtual environments, see page: `about-venvs`
|
|
|
|
We require installing Red into a virtual environment. Don't be scared, it's very
|
|
straightforward.
|
|
|
|
**************************
|
|
Using ``pyenv virtualenv``
|
|
**************************
|
|
|
|
Using ``pyenv virtualenv`` saves you the headache of remembering where you installed your virtual
|
|
environments. This option is only available if you installed Python with pyenv.
|
|
|
|
First, ensure your pyenv interpreter is set to python 3.8.1 or greater with the following command:
|
|
|
|
.. prompt:: bash
|
|
|
|
pyenv version
|
|
|
|
Now, create a virtual environment with the following command:
|
|
|
|
.. prompt:: bash
|
|
|
|
pyenv virtualenv <name>
|
|
|
|
Replace ``<name>`` with whatever you like. If you ever forget what you named it,
|
|
you can always use the command ``pyenv versions`` to list all virtual environments.
|
|
|
|
Now activate your virtualenv with the following command:
|
|
|
|
.. prompt:: bash
|
|
|
|
pyenv shell <name>
|
|
|
|
.. important::
|
|
|
|
You must activate the virtual environment with the above command every time you open a new
|
|
shell to run, install or update Red. You can check out other commands like ``pyenv local`` and
|
|
``pyenv global`` if you wish to keep the virtualenv activated all the time.
|