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.

Sign up for GitHub

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

Add a recipe for setting up a virtualenv #5

Merged
merged 4 commits into from
Feb 28, 2021
Merged

Add a recipe for setting up a virtualenv #5

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
80c0934
Add a recipe for setting up a virtualenv
mwichmann Feb 5, 2021
318f19a
Tweak virtualenv setup further
mwichmann Feb 9, 2021
6e86088
Review fix: virtualenv startup fixed
mwichmann Feb 24, 2021
100e275
Pick better pygments lexers for virtualenv
mwichmann Feb 25, 2021
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
2 changes: 2 additions & 0 deletions docs/SConsCookbook.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,5 @@ doing various things.

.. include:: recipes/msvc-external-debug.rst

.. include:: recipes/virtualenv.rst

65 changes: 65 additions & 0 deletions docs/recipes/virtualenv.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
Setting Up a Python Virtualenv for SCons
----------------------------------------

It is often useful to set up a virtualenv when working with a project
that uses SCons to build. A virtualenv is a way to create an
isolated execution environment - you can install whatever you need
there, and change versions as needed, without affecting anything
else on your system that uses Python. Here is an example session
for setting one up:

.. code:: shell

$ cd Work
$ python -m venv myvenv
$ cd myvenv
Copy link
Contributor

Choose a reason for hiding this comment

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

You shouldn't need to cd into myenv to source bin/activate

For windows you use scripts/activate.bat or activate.ps1(for powershell)

$ source bin/activate
Copy link
Contributor

Choose a reason for hiding this comment

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

source myvenv/bin/activate

Copy link
Contributor

Choose a reason for hiding this comment

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

and actually . myvenv/bin/activate should also work. (that's what I typically do, less typing.. )

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah, hand-editing logs never works out right

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can trim these further if you want - just trying to figure out what still needs doing here to complete this.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yup. If you can fix that, then we're good to go.

(myvenv) $ python -m pip list --outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

Only time I use python -m pip is on windows to upgrade pip itself

I'd just use pip here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can change that; if the virtualenv is active, pip indeed will be "the correct one", I just usually use this form when showing people stuff in order to cultivate good habits. People get itno a lot of trouble just running pip, and then "why won't Python find my module".

Package Version Latest Type
---------- ------- ------ -----
pip 19.3.1 21.0.1 wheel
setuptools 41.6.0 53.0.0 wheel
WARNING: You are using pip version 19.3.1; however, version 21.0.1 is available.
You should consider upgrading via the 'pip install --upgrade pip' command.
(myvenv) $ python -m pip install --upgrade pip setuptools scons
Copy link
Contributor

Choose a reason for hiding this comment

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

But not here, and maybe include a comment about why.. though pip install -U pip works on non-windows, it fails on windows.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Took a moment to parse this. Anyway, I have the equivalent Windows log from the same time, just wasn't sure if it needed to be added to the recipe.

C:\Users\mats>cd Work

C:\Users\mats\Work>py -m venv myvenv

C:\Users\mats\Work>cd myvenv

C:\Users\mats\Work\myvenv>.\Scripts\activate

(myvenv) C:\Users\mats\Work\myvenv>python -m pip list --outdated
Package    Version Latest Type
---------- ------- ------ -----
pip        20.2.3  21.0.1 wheel
setuptools 49.2.1  53.0.0 wheel
WARNING: You are using pip version 20.2.3; however, version 21.0.1 is available.You should consider upgrading via the 'C:\Users\mats\Work\myvenv\Scripts\python.exe -m pip install --upgrade pip' command.

(myvenv) C:\Users\mats\Work\myvenv>python -m pip install --upgrade pip setuptools scons
Collecting pip
  Using cached pip-21.0.1-py3-none-any.whl (1.5 MB)
Collecting setuptools
  Using cached setuptools-53.0.0-py3-none-any.whl (784 kB)
Collecting scons
  Using cached SCons-4.1.0.post1-py3-none-any.whl (4.1 MB)
Installing collected packages: pip, setuptools, scons
  Attempting uninstall: pip
    Found existing installation: pip 20.2.3
    Uninstalling pip-20.2.3:
      Successfully uninstalled pip-20.2.3
  Attempting uninstall: setuptools
    Found existing installation: setuptools 49.2.1
    Uninstalling setuptools-49.2.1:
      Successfully uninstalled setuptools-49.2.1
Successfully installed pip-21.0.1 scons-4.1.0.post1 setuptools-53.0.0

(myvenv) C:\Users\mats\Work\myvenv>scons --version
SCons by Steven Knight et al.:
        SCons: v4.1.0.post1.dc58c175da659d6c0bb3e049ba56fb42e77546cd, 2021-01-20 04:32:28, by bdbaddog on ProDog2020
        SCons path: ['c:\\users\\mats\\work\\myvenv\\lib\\site-packages\\SCons']
Copyright (c) 2001 - 2021 The SCons Foundation

(myvenv) C:\Users\mats\Work\myvenv>

Collecting pip
Downloading https://files.pythonhosted.org/packages/fe/ef/60d7ba03b5c442309ef42e7d69959f73aacccd0d86008362a681c4698e83/pip-21.0.1-py3-none-any.whl (1.5MB)
|................................| 1.5MB 909kB/s
Collecting setuptools
Downloading https://files.pythonhosted.org/packages/15/0e/255e3d57965f318973e417d5b7034223f1223de500d91b945ddfaef42a37/setuptools-53.0.0-py3-none-any.whl (784kB)
|................................| 788kB 1.2MB/s
Collecting scons
Using cached https://files.pythonhosted.org/packages/de/8c/4da2c7dd43466383b7ade4189d995c2102248f507af7ba6f456df0854920/SCons-4.1.0.post1-py3-none-any.whl
Installing collected packages: pip, setuptools, scons
Found existing installation: pip 19.3.1
Uninstalling pip-19.3.1:
Successfully uninstalled pip-19.3.1
Found existing installation: setuptools 41.6.0
Uninstalling setuptools-41.6.0:
Successfully uninstalled setuptools-41.6.0
Successfully installed pip-21.0.1 scons-4.1.0.post1 setuptools-53.0.0
(myvenv) $ python -m pip list
Package Version
---------- -----------
pip 21.0.1
SCons 4.1.0.post1
setuptools 53.0.0
(myvenv) [mats@boulder myvenv]$ scons --version
SCons by Steven Knight et al.:
SCons: v4.1.0.post1.dc58c175da659d6c0bb3e049ba56fb42e77546cd, 2021-01-20 04:32:28, by bdbaddog on ProDog2020
SCons path: ['/home/mats/Work/myvenv/lib64/python3.8/site-packages/SCons']
Copyright (c) 2001 - 2021 The SCons Foundation
(myvenv) $ deactivate
$

To use this virtualenv for work, repeat the
step to activate it, go to your project, and install
any additional requirements your project may have
(skip this step if there are none).

.. code:: shell

$ cd Work/myproject
$ source ~/Work/myvenv/bin/activate
$ python -m pip install -r requirements.txt