API

cpenv.api.activate(requirements, ignore_unresolved=False)

Resolve and active a list of module requirements.

Usage:

>>> cpenv.activate('moduleA', 'moduleB')

Arguments:

requirements (List[str]): List of module requirements

Returns:

list of Module objects that have been activated

cpenv.api.deactivate()

Deactivates an environment by restoring all env vars to a clean state stored prior to activating environments

cpenv.api.clone(module, from_repo=None, where=None, overwrite=False)

Clone a module for local development.

A typical development workflow using clone and publish:

1. clone a module
2. make changes
3. test changes
4. increment version in module.yml
5. publish a new version of your module

cpenv.api.create(where, name, version, **kwargs)

Create a new module.

Arguments:

where (str): Path to new module name (str): Name of module version (str): Version of module description (str): Optional description of module author (str): Optional author of module email (str): Optional email address of author requires (list): Optional modules that this module depends on environment (dict): Optional environment variables

Returns:

Module object

cpenv.api.localize(requirements, to_repo='home', overwrite=False, ignore_unresolved=False)

Localize a list of requirements.

cpenv.api.publish(module, to_repo='home', overwrite=False)

Publish a module to the specified repository.

cpenv.api.resolve(requirements, ignore_unresolved=False)

Resolve a list of module requirements.

cpenv.api.set_home_path(path)

Convenient function used to set the CPENV_HOME environment variable.

cpenv.api.get_home_path()

Returns the cpenv home directory.

Default home paths:

win - C:/ProgramData/cpenv mac - /Library/Application Support/cpenv OR /Library/Caches/cpenv linux - /usr/local/share/cpenv OR ~/.local/share/cpenv

cpenv.api.get_home_modules_path()

Return the modules directory within the cpenv home directory.

cpenv.api.get_cache_path(*parts)

Return the cpenv cache directory within the cpenv home directory.

Arguments:

*parts (str) - List of path parts to join with cache path

cpenv.api.get_user_path()

Returns the cpenv user directory.

Default user paths:

win - C:/Users/<username>/AppData/Roaming/cpenv mac - ~/Library/Application Support/cpenv linux - ~/.local/share/cpenv

cpenv.api.get_user_modules_path()

Returns the modules directory within the cpenv user directory.

Default user paths:

win - C:/Users/<username>/AppData/Roaming/cpenv/modules mac - ~/Library/Application Support/cpenv/modules linux - ~/.local/share/cpenv/modules

cpenv.api.get_modules(*requirements)

Returns a list of available modules.

cpenv.api.get_module_paths()

Returns a list of paths used to lookup local modules.

The list of lookup paths contains:

1. use modules path
2. home modules path
3. paths in CPENV_MODULES environment variable

cpenv.api.add_module_path(path)

Add an additional lookup path for local modules.

cpenv.api.get_active_modules()

Returns a list of active Module s

cpenv.api.add_active_module(module)

Add a module to CPENV_ACTIVE_MODULES environment variable.

Arguments:

module (Module): Module to add to CPENV_ACTIVE_MODULES

cpenv.api.remove_active_module(module)

Remove a module from CPENV_ACTIVE_MODULES environment variable.

Arguments:

module (Module): Module to remove from CPENV_ACTIVE_MODULES

cpenv.api.get_repos()

Get a list of all registered Repos.

cpenv.api.get_repo(name, **query)

Get a repo by specifying an attribute to lookup

cpenv.api.add_repo(repo, priority=None)

Register a Repo.

Arguments:

priority (int): Override the Repos priority when adding.

cpenv.api.read_config(key=None, default=<object object>)

Read the whole config or a specific key from disk.

Examples:

# Read whole config config = read_config()

# Read one key repos = read_config(‘repos’, {})

cpenv.api.write_config(*args)

Write the whole config or a specific key to disk.

Examples:

# Write whole config write_config({‘repos’: {}})

# Write one config key write_config(‘repos’, {})

cpenv.api.update_repo(repo)

Update a registered repo.

cpenv.api.remove_repo(repo)

Unregister a Repo.

class cpenv.hooks.HookFinder(*hook_paths)

Find python hooks by name in the provided path.

usage:

>>> hook_finder = HookFinder('~/.cpenv/hooks')
>>> hook = hook_finder('precreate')
>>> hook.run(env=VirtualEnvironment('path/to/env'))

cpenv.hooks.get_global_hook_path()

Returns the global hook path

cpenv.hooks.run_global_hook(hook_name, *args)

Attempt to run a global hook by name with args

exception cpenv.resolver.ResolveError

Raised when a Resolver fairs to resolve a module or list of modules.

class cpenv.resolver.Resolver(repos)

Responsible for resolving ModuleSpecs from requirement strings.

Modules will be looked up sequentially in all registered Repos. By default this order is:

1. LocalRepo pointing to current working directory
2. LocalRepo pointing to cpenv_user_modules_path
3. LocalRepo pointing to cpenv_home_modules_path ($CPENV_HOME/modules)
4. LocalRepos pointing to the paths in $CPENV_MODULES
5. Custom Repos registered via cpenv.add_repo

If there are still unresolved modules, fallback to the old algorithm for module lookups using the resolve functions in the cpenv.resolver.module_resolvers list.

resolve(requirements, ignore_unresolved=False)

Given a list of requirement strings, resolve ModuleSpecs.

Returns:

list of ModuleSpec objects

Raises:

ResolveError when a requirement can not be resolved.

class cpenv.resolver.Activator(localizer=None)

Responsible for activating modules.

activate(module_specs)

Activate a list of module specs.

combine_modules(modules)

Combine a list of module’s environments.

class cpenv.resolver.Copier(to_repo)

Responsible for copying modules to a specific module.

copy(module_specs, overwrite=False)

Given ModuleSpecs, copy them to this copiers to_repo.

class cpenv.resolver.Localizer(to_repo='home')

Downloads modules from remote Repos to a specific LocalRepo.

This is similar to a copy operation, but skips all module_specs that are already in LocalRepos. If they are in LocalRepos then they are already available to be activated.

localize(module_specs, overwrite=False)

Given ModuleSpecs, download them to this Localizers repo.

cpenv.resolver.is_redirecting(path)

Returns True if path contains a .cpenv file

cpenv.resolver.redirect_to_modules(path)

Get environment path from redirect file

cpenv.resolver.parse_redirect(data)

Parses a redirect string - data of a .cpenv file