Use this project to manage smart sales.

• Additional information: https://github.com/denisecase/pro-analytics-02

Proper setup is critical. Complete each step in the following guide and verify carefully.

• SET UP MACHINE

After verifying your machine is set up, set up a new Python project by copying this template. Complete each step in the following guide.

• SET UP PROJECT

It includes the critical commands to set up your local environment (and activate it):

uv python pin 3.12
uv venv
uv sync --extra dev --extra docs --upgrade
uv run pre-commit install
uv run python --version

Windows (PowerShell):

.\.venv\Scripts\activate

macOS / Linux / WSL:

source .venv/bin/activate

Please ensure that the prior steps have been verified before continuing. When working on a project, we open just that project in VS Code.

Always start with git pull to check for any changes made to the GitHub repo.

git pull

This mirrors real work where we typically:

1. Update dependencies (for security and compatibility).
2. Clean unused cached packages to free space.
3. Use git add . to stage all changes.
4. Run ruff and fix minor issues.
5. Update pre-commit periodically.
6. Run pre-commit quality checks on all code files (twice if needed, the first pass may fix things).
7. Run tests.

In VS Code, open your repository, then open a terminal (Terminal / New Terminal) and run the following commands one at a time to check the code.

uv sync --extra dev --extra docs --upgrade
uv cache clean
git add .
uvx ruff check --fix
uvx pre-commit autoupdate
uv run pre-commit run --all-files
git add .
uv run pytest

NOTE: The second git add . ensures any automatic fixes made by Ruff or pre-commit are included before testing or committing.

Make sure you have current doc dependencies, then build your docs, fix any errors, and serve them locally to test.

uv run mkdocs build --strict
uv run mkdocs serve

• After running the serve command, the local URL of the docs will be provided. To open the site, press CTRL and click the provided link (at the same time) to view the documentation. On a Mac, use CMD and click.
• Press CTRL c (at the same time) to stop the hosting process.

This project includes demo code. Run the demo Python modules to confirm everything is working. After confirming, we can delete the demo code and use the examples for our project-specific modules, like "data_prep".

In VS Code terminal, run:

uv run python -m analytics_project.data_preparation.prepare_customers
uv run python -m analytics_project.data_preparation.prepare_products
uv run python -m analytics_project.data_preparation.prepare_sales

uv run python -m analytics_project.data_prep

uv run python -m analytics_project.dw.etl_to_dw

uv run python -m analytics_project.olap.cubing
uv run python -m analytics_project.olap.goal_sales_by_day
uv run python -m analytics_project.olap.goal_top_product_by_day

Anytime we make working changes to code is a good time to git add-commit-push to GitHub.

1. Stage changes with git add.
2. Commit changes with a useful message in quotes.
3. Push work to GitHub.

git add .
git commit -m "describe your change in quotes"
git push -u origin main

This will trigger the GitHub Actions workflow and publish your documentation via GitHub Pages.

With a working version safe in GitHub, start making changes to the code.

Before starting a new session, remember to do a git pull and keep your tools updated.

Each time forward progress is made, remember to git add-commit-push.