datafun-02-automation

Professional Python project: automation and repetition.

Project Planning

One advantage of code is that it makes it easy to repeat a set of logic. In this project, we implement a variety of options for repeating a process in Python.

Think of logic you might want to repeat:

• logic for each number in a sequence
• logic for each item in a list
• converting a list into another list
• logic that repeats while a condition is true

This project uses all these techniques to automate the creation of project text files. All these are widely applicable in analytics.

Important: Git add-commit-push project.log and generated .txt files (along with other project files).

---

Three Workflows

There are three workflows for analytics projects.

• 01: Set Up Machine (Once Per Machine)
• 02: Set Up Project (Once Per Project)
• 03: Daily Workflow (Working With Python Project Code)

01: Set Up Machine (Once Per Machine)

Follow the detailed instructions at: 01. Set Up Your Machine

02: Set Up Project (Once Per Project)

1. Get Repository: Sign in to GitHub, open this repository in your browser, and click Copy this template to get a copy in YOURACCOUNT.

2. Configure Repository Settings:

   • Select your repository Settings (the gear icon way on the right).
   • Go to Pages tab / Enable GitHub Pages / Build and deployment / set Source to GitHub Actions
   • Go to Advanced Security tab / Dependabot / Dependabot security updates / Enable
   • Go to Advanced Security tab / Dependabot / Grouped security updates / Enable

3. Clone to local: Open a machine terminal in your Repos folder and clone your new repo.

git clone https://github.com/YOURACCOUNT/datafun-02-automation

4. Open project in VS Code: Change directory into the repo and open the project in VS Code by running code . ("code dot"):

cd datafun-02-automation
code .

5. Install recommended extensions.

   • When VS Code opens, accept the Extension Recommendations (click Install All or similar when asked).

6. Set up a project Python environment (managed by uv) and align VS Code with it.

   • Use VS Code menu option Terminal / New Terminal to open a VS Code terminal in the root project folder.
   • Run the following commands, one at a time, hitting ENTER after each:

   uv self update
   uv python pin 3.14
   uv sync --extra dev --extra docs --upgrade

If asked: "We noticed a new environment has been created. Do you want to select it for the workspace folder?" Click "Yes".

If successful, you'll see a new .venv folder appear in the root project folder.

Follow the steps to Align VS Code with the Environment .

Optional (recommended): install and run pre-commit checks (repeat the git add and commit twice if needed):

uvx pre-commit install
git add -A
uvx pre-commit run --all-files
git add -A
uvx pre-commit run --all-files

Fore more detailed instructions and troubleshooting, see the pro guide at: 02. Set Up Your Project

🛑 Do not continue until all REQUIRED steps are complete and verified.

03: Daily Workflow (Working With Python Project Code)

Commands are provided below to:

1. Git pull
2. Run and check the Python files
3. Build and serve docs
4. Save progress with Git add-commit-push
5. Update project files

VS Code should have only this project (datafun-02-automation) open. Use VS Code menu option Terminal / New Terminal and run the following commands:

git pull

In the same VS Code terminal, run any Python source files:

uv run python src/datafun_02_automation/app_case.py
uv run python src/datafun_02_automation/app_yourname.py

If a command fails, verify:

• Only this project is open in VS Code.
• The terminal is open in the project root folder.
• The uv sync --extra dev --extra docs --upgrade command completed successfully.

Hint: if you run ls in the terminal, you should see files including pyproject.toml, README.md, and uv.lock.

Run Python checks and tests (as available):

uv run ruff format .
uv run ruff check . --fix
uv run pytest

Build and serve docs (hit CTRL+c in the VS Code terminal to quit serving):

uv run mkdocs build --strict
uv run mkdocs serve

While editing project code and docs, repeat the commands above to run files, check them, and rebuild docs as needed.

Save progress frequently (some tools may make changes; you may need to re-run git add and commit to ensure everything gets committed before pushing):

git add -A
git commit -m "update"
git push -u origin main

Additional details and troubleshooting are available in the Pro-Analytics-02 Documentation.

---

Project Objectives

Project Task 1. Personalize Your Documentation Links

Open mkdocs.yaml. This file configures the associated project documentation website (powered by MkDocs) Use CTRL+f to find each occurrence of the source GitHub account (e.g. denisecase). Change each occurrence to point to your GitHub account instead (spacing and capitalization MUST match the URL of your GitHub account exactly.)

Project Task 2. Personalize Your Python File

1. Rename app_yourname.py to reflect your name or alias.

• Find the file the file in the VS Code Explorer window (top icon on the left).
• Right-click / Rename.
• Follow conventions: name Python files in lower_snake_case, words joined with underscores, and using .py extension.

2. Edit this README.md file to change the run command to call your file instead. Use CTRL+f to search for app_yourname.py and replace all occurrences exactly.
3. Preview this README.md to make sure it still appears correctly.
   • Find README.md in the VS Code Explorer window (top icon on the left)
   • Right-click / Preview
   • Fix any issues.
4. Run the updated command to execute your Python script.

Project Task 3. Implement Your Python File

1. Read the example code carefully before starting.
2. Open your file. Search for "TODO" items. VS Code has icons down the left. Use either TODO Tree (tree, at the bottom) or Search (second from top).
3. Complete each TODO carefully, one at a time.
4. After implementing a TODO, paste your run command in the terminal and hit Enter to re-run it.
5. When it runs without errors, delete the associated TODO command.
6. Keep working through each TODO.
7. When you finish, there should be zero TODO occurrences in your project.
8. Use VS Code menu File / Save to save your changes. OR better yet, ensure File / Auto save is checked.
9. NOTE: I use File / Autosave (which works very well in VS Code), so I rarely remember to include File / Save in instructions.

Save often: After making any useful progress, follow the steps to git add-commit-push shown above.

---

Notes

• You do not need to add to or modify tests/. They are provided for example only.
• You do not need to view or modify any of the supporting config files.
• Many of the repo files are silent helpers. Explore as you like, but nothing is required.
• You do NOT need to understand everything. Understanding builds naturally over time.
• Use the UP ARROW and DOWN ARROW in the terminal to scroll through past commands.
• Use CTRL+f to find (and replace) with in a file.

Troubleshooting >>> or ...

If you see something like this in your terminal: >>> or ... You accidentally started Python interactive mode. It happens. Press Ctrl+c (both keys together) or Ctrl+Z then Enter on Windows.

Resources

• Pro-Analytics-02 - guide to professional Python
• ANNOTATIONS.md - REQ/WHY/OBS annotations used
• INSTRUCTORS.md - guidance and notes for instructors and maintainers
• POLICIES.md - project rules and expectations that apply to all contributors
• SE_MANIFEST.toml - project intent, scope, and role

Citation

CITATION.cff - TODO: update author and repository fields to reflect your creative work

License

MIT