Public API¶
Create virtual environments with repo-helper
.
Functions:
|
Install requirements into a virtualenv. |
|
Create a “devenv”. |
|
Reads the |
-
install_requirements
(session, requirements_file, verbosity=1, *, upgrade=False)[source]¶ Install requirements into a virtualenv.
- Parameters
Changed in version 0.4.0: Added the
upgrade
keyword-only argument.Deprecated since version 0.5.0: This will be removed in 1.0.0.
-
mkdevenv
(repo_dir, venv_dir='venv', verbosity=1, *, upgrade=False)[source]¶ Create a “devenv”.
New in version 0.3.2.
- Parameters
repo_dir (
Union
[str
,Path
,PathLike
]) – The root of the repository to create the devenv for.venv_dir (
Union
[str
,Path
,PathLike
]) – The directory to create the devenv in, relative torepo_dir
. Default'venv'
.verbosity (
int
) – The verbosity of the function.0
= quiet,2
= very verbose. Default1
.upgrade (
bool
) – Whether to upgrade all specified packages to the newest available version. DefaultFalse
.
- Return type
Changed in version 0.4.0: Added the
upgrade
keyword-only argument.