example package

Submodules

example.welcome module

class example.welcome.Greeting[source]

Bases: object

A class to represent a welcome greeting.

a_person(named=None)[source]

A welcome message for a person by their name.

Args:: named (str, optional): A person’s name. Defaults to None.
Raises:: NotImplementedError: If no named person is passed in as a parameter.
Returns:: str: A welcome message with a person’s name.

bmi_203()[source]: A welcome message for the students.

the_zen_of_python(read_file: str) → list[str][source]

Reads a text file containing The Zen of Python and returns a list where each element is one line of the 19 aphorisms.

Args:: read_file (str): Path to the txt file containing The Zen of Python.
Returns:: list[str]: List of strings, where each element is one line of The Zen of Python.

Module contents

UCSF BMI203: Biocomputing Algorithms Winter 2023 Author: Andrew Blair Date: 01.06.23 Package: example Description: An example for how to build GitHub Actions, Python packaging, unit testing, containers, and Read the Docs.