Skip to content

Snap package template

Snap Package Template.

This is a template for the Snap Python package, designed for easy starting and structuring of Python projects. This package includes basic versioning and a simple function example.

ATTRIBUTE	DESCRIPTION
`__version__`	The current version of the package. TYPE: `str`
`__version_tuple__`	The current version of the package as a tuple. TYPE: `tuple`

`some_function()` ¤

Demonstrate the structure of a Python function.

This function returns a test string.

RETURNS	DESCRIPTION
`str`	A string containing "some_variable_to_test".

Source code in src/snapenv_core/__init__.py

def some_function() -> str:
    """
    Demonstrate the structure of a Python function.

    This function returns a test string.

    Returns
    -------
    str
        A string containing "some_variable_to_test".
    """
    return "some_variable_to_test"