Skip to content

Your Files

Projects include instructor example files that typically end with _case. Keep these as working examples.

You will generally copy the instructor file, rename it with your alias, and run your version in addition to the example version.

Choose Your Name (example: stellar_analytics)

You may use your real name or any professional alias. You are never required to use your real name.

Naming rules:

  • all lowercase
  • no spaces (use underscores as needed)

1. Python Files

Copy an example Python file and rename the copy using your alias. For example:

src/**/app_case.py
src/**/app_stellar_analytics.py

2. Python Execution Command (as needed)

In your README.md, just after any example execution command, add a line with your execution command. Verify your command runs your code. For example:

uv run python -m datafun.app_case
uv run python -m datafun.app_stellar_analytics

3. Data Files (as needed)

Example data files are typically found in data/raw/.

Copy any example data file(s) provided and rename the copy using your alias.

This helps discover the importance of data paths.

For assistance, use the VS Code search in files (the microscope icon on the left) to find everywhere that data/ appears in the project.

Paths are critical and can be hard to get right. That's why we log them and learn how to search for them. In Python, we declare constants to help keep them straight.

A renaming example might be:

data/raw/data_case.csv
data/raw/data_yourname.csv

Final Set Includes Example Files AND Your Alias Files

Remember to keep the original data/raw/ files and the original code to keep the provided example working.

Modify the your code files and your data files as you develop your custom project.

Project Requirements

You may choose your own datasets and most of the file names.

However, for accountability and to earn maximum credit:

Data and code filenames should include your alias.