rse package

Subpackages

Submodules

rse.defaults module

Copyright (C) 2020 Vanessa Sochat.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

rse.defaults.getenv(variable_key, default=None, required=False, silent=True)[source]

attempt to get an environment variable. If the variable is not found, None is returned.

Arguments:

  • variable_key (str) : the variable name

  • required (bool) : exit with error if not found

  • silent (bool) : Do not print debugging information

rse.exceptions module

Copyright (C) 2020 Vanessa Sochat.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

exception rse.exceptions.DatabaseStringFormatError[source]

Bases: RuntimeError

Thrown if database prefix is not supported

exception rse.exceptions.DirectoryNotFoundError(dirname, reason, *args, **kwargs)[source]

Bases: FileNotFoundError

Thrown if a directory is not found

exception rse.exceptions.MissingDatabaseString(reason=None, *args, **kwargs)[source]

Bases: RuntimeError

Thrown if a database string is required and not provided

exception rse.exceptions.MissingEnvironmentVariable(varname, *args, **kwargs)[source]

Bases: RuntimeError

Thrown if a required environment variable is not provided.

exception rse.exceptions.MultipleReposExistError(uid, *args, **kwargs)[source]

Bases: rse.exceptions.RepoError

Thrown if multiple repos exist.

exception rse.exceptions.NoReposError(*args, **kwargs)[source]

Bases: rse.exceptions.RepoError

Thrown if repos are requested, but there are none

exception rse.exceptions.RepoError(uid=None, reason=None, *args, **kwargs)[source]

Bases: RuntimeError

Abstract base class for any kind of RepoError.

exception rse.exceptions.RepoMetadataExistError(uid, key, *args, **kwargs)[source]

Bases: rse.exceptions.RepoError

Thrown if a metadata value (label) already exists.

exception rse.exceptions.RepoNotFoundError(uid, *args, **kwargs)[source]

Bases: rse.exceptions.RepoError

Thrown if a repo does not exist (for a remote)

rse.version module

Copyright (C) 2020 Vanessa Sochat.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

Module contents

Copyright (C) 2020 Vanessa Sochat.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.