Library reference

Data attributes

nusex.__productname__
nusex.__version__

The currently installed version, represented in the PEP 440 format.

nusex.__description__
nusex.__url__

A link to the GitHub repository.

nusex.__docs__

A link to the documentation.

nusex.__author__
nusex.__author_email__
nusex.__license__
nusex.__bugtracker__

A link to the issues page on the GitHub repository.

nusex.__ci__

A link to the actions page on the GitHub repository.

Exceptions

exception nusex.errors.NusexError

The base exception class for nusex.

exception nusex.errors.NusexUserError

An error occurred due to user error.

exception nusex.errors.ProfileError

Something went wrong when working with a profile.

exception nusex.errors.TemplateError

Something went wrong when working with a template.

exception nusex.errors.BuildError

A template failed to build.

exception nusex.errors.DeploymentError

A template failed to deploy.

exception nusex.errors.AlreadyExists

A profile or template already exists.

exception nusex.errors.DoesNotExist

A profile or template does not exist.

exception nusex.errors.DownloadError

A download failed to complete, or an invalid download request was submitted.

exception nusex.errors.UnsupportedFile

An invalid file has been passed to a decoder, or a file larger than the file size limit has been included in a template.

exception nusex.errors.IncompatibilityError

A operation is incompatible with your OS, Python version, or Python implementation.

exception nusex.errors.MigrationError

A migration or migration reversion failed.

Exception hierarchy

  • Exception
    • NusexError
      • NusexUserError
        • ProfileError

        • TemplateError
          • BuildError

          • DeploymentError

        • AlreadyExists

        • DoesNotExist

        • :exc:`MigrationError

      • DownloadError

      • UnsupportedFile

      • IncompatibilityError`