Skip to content

API Reference

Top Level Module

aieng_template_uv

Top level module.

hello 

hello()

UV's hello world.

Returns:

Type Description
str: A friendly hello.
Source code in src/aieng_template_uv/__init__.py 
 4
 5
 6
 7
 8
 9
10
11
def hello() -> str:
    """UV's hello world.

    Returns
    -------
        str: A friendly hello.
    """
    return "Hello from aieng-template-uv!"

bar

bar module.

bar 

bar(foo)

Return input concatenated with 'bar'.

Parameters:

Name Type Description Default
foo str

Input string to be concatenated with 'bar'.

 required

Returns:

Type Description
str

Concatenated string.

Examples:

>>> bar("foo")
'barfoo'
>>> bar("baz")
'barbaz'
Source code in src/aieng_template_uv/bar.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
def bar(foo: str) -> str:
    """Return input concatenated with 'bar'.

    Parameters
    ----------
    foo : str
        Input string to be concatenated with 'bar'.

    Returns
    -------
    str
        Concatenated string.

    Examples
    --------
    >>> bar("foo")
    'barfoo'
    >>> bar("baz")
    'barbaz'

    """
    return f"bar{foo}"

foo

foo module.

foo 

foo(bar)

Return input concatenated with 'foo'.

Parameters:

Name Type Description Default
bar str

Input string to be concatenated with 'foo'.

 required

Returns:

Type Description
str

Concatenated string.

Examples:

>>> foo("bar")
'foobar'
>>> foo("baz")
'foobaz'
Source code in src/aieng_template_uv/foo.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
def foo(bar: str) -> str:
    """Return input concatenated with 'foo'.

    Parameters
    ----------
    bar : str
        Input string to be concatenated with 'foo'.

    Returns
    -------
    str
        Concatenated string.

    Examples
    --------
    >>> foo("bar")
    'foobar'
    >>> foo("baz")
    'foobaz'

    """
    return f"foo{bar}"

Foo Module

aieng_template_uv.foo

foo module.

foo 

foo(bar)

Return input concatenated with 'foo'.

Parameters:

Name Type Description Default
bar str

Input string to be concatenated with 'foo'.

 required

Returns:

Type Description
str

Concatenated string.

Examples:

>>> foo("bar")
'foobar'
>>> foo("baz")
'foobaz'
Source code in src/aieng_template_uv/foo.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
def foo(bar: str) -> str:
    """Return input concatenated with 'foo'.

    Parameters
    ----------
    bar : str
        Input string to be concatenated with 'foo'.

    Returns
    -------
    str
        Concatenated string.

    Examples
    --------
    >>> foo("bar")
    'foobar'
    >>> foo("baz")
    'foobaz'

    """
    return f"foo{bar}"

Bar Module

aieng_template_uv.bar

bar module.

bar 

bar(foo)

Return input concatenated with 'bar'.

Parameters:

Name Type Description Default
foo str

Input string to be concatenated with 'bar'.

 required

Returns:

Type Description
str

Concatenated string.

Examples:

>>> bar("foo")
'barfoo'
>>> bar("baz")
'barbaz'
Source code in src/aieng_template_uv/bar.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
def bar(foo: str) -> str:
    """Return input concatenated with 'bar'.

    Parameters
    ----------
    foo : str
        Input string to be concatenated with 'bar'.

    Returns
    -------
    str
        Concatenated string.

    Examples
    --------
    >>> bar("foo")
    'barfoo'
    >>> bar("baz")
    'barbaz'

    """
    return f"bar{foo}"