Skip to content

API Reference

This page provides detailed API documentation for CrustyPy Instance.

Main Module

crustypy_instance

Generated with CrustyPy.

Functions

make_greeting 

make_greeting(name: str) -> str

Make greeting message.

This function is an example, and should be deleted once you're familiar with how the project is structured.

Make sure to also remove this function from the __init__.py file, as well as from the tests.

Parameters:

Name Type Description Default
name str

The name of the person to greet.

 required

Returns:

Type Description
str

A greeting message for that person.

Examples:

>>> print(make_greeting("Foo"))
Hello, Foo. Welcome to your new project!
Source code in src/crustypy_instance/_crustypy_instance.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
def make_greeting(name: str) -> str:
    """Make greeting message.

    This function is an example, and should be deleted once
    you're familiar with how the project is structured.

    Make sure to also remove this function from the `__init__.py`
    file, as well as from the tests.

    Args:
        name: The name of the person to greet.

    Returns:
        A greeting message for that person.

    Examples:
        >>> print(make_greeting("Foo"))
        Hello, Foo. Welcome to your new project!
    """
    logger.debug(f"Welcoming {name}.")
    return f"Hello, {name}. Welcome to your new project!"