https://github.com/denisecase/pro-analytics-02
Professional Python project starter and guide using uv, Ruff, MkDocs, and GitHub Actions (2026)
https://github.com/denisecase/pro-analytics-02
automation ci data-analytics deploy documentation github-actions mkdocs professional project python ruff uv
Last synced: 18 days ago
JSON representation
Professional Python project starter and guide using uv, Ruff, MkDocs, and GitHub Actions (2026)
- Host: GitHub
- URL: https://github.com/denisecase/pro-analytics-02
- Owner: denisecase
- License: mit
- Created: 2025-10-15T15:55:48.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2026-05-20T18:01:57.000Z (about 1 month ago)
- Last Synced: 2026-05-20T22:05:50.967Z (about 1 month ago)
- Topics: automation, ci, data-analytics, deploy, documentation, github-actions, mkdocs, professional, project, python, ruff, uv
- Language: Python
- Homepage: https://denisecase.github.io/pro-analytics-02/
- Size: 1.36 MB
- Stars: 2
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Pro Analytics 02
[](https://denisecase.github.io/pro-analytics-02/)
[](https://github.com/denisecase/pro-analytics-02/blob/main/pyproject.toml)
[](https://github.com/denisecase/pro-analytics-02/actions/workflows/ci-python-zensical.yml)
[](LICENSE)
[](https://github.com/denisecase/pro-analytics-02/actions/workflows/ci-python-zensical.yml)
[](https://github.com/denisecase/pro-analytics-02/actions/workflows/deploy-zensical.yml)
[](https://github.com/denisecase/pro-analytics-02/actions/workflows/links.yml)
[](https://github.com/denisecase/pro-analytics-02/security)
> Professional Python project starter and guide.
## Overview and Scope
This repository serves two purposes:
1. A **ready-to-use starter repository** for professional Python projects
2. A **reference guide** for modern Python workflows
It demonstrates a professional Python project structure, tooling configuration, and documentation practices.
## Documentation Site
This repository includes an associated
[**documentation site**](https://denisecase.github.io/pro-analytics-02/).
## Developers and Maintainers
This is a reference site. Most people do not need to get this running on their machine.
For developers and maintainers (or if you want to fork your own copy).
### Set Up Machine
- Complete 🟢
[Workflow A. Set Up Machine](https://denisecase.github.io/pro-analytics-02/workflow-a-set-up-machine/)
to **set up a machine** for Python development.
### Copy & Open this Project in VS Code
1. Sign in to GitHub, open this repository in your browser.
2. Click **Copy this template** to get a copy in **YOURACCOUNT**.
3. Enable GitHub Pages.
Open a terminal on your machine (not VS Code) in your Repos folder and run:
```shell
git clone https://github.com/YOURACCOUNT/pro-analytics-02
cd pro-analytics-02
code .
```
When VS Code opens, accept the Extension Recommendations (click **`Install All`** or similar when asked).
### Create and Manage the Project Environment
Use VS Code menu option `Terminal` / `New Terminal` to open a
**VS Code terminal** in the root project folder.
To set up a project Python environment (managed by `uv`) and align VS Code with it,
run the following commands, one at a time, hitting ENTER after each:
```shell
# reset uv cache if strange dependency errors appear
# del .venv
# uv cache clean
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.
Install and run pre-commit checks (twice if necessary as shown below):
```shell
uvx pre-commit install
git add -A
uvx pre-commit run --all-files
# repeat if changes were made
git add -A
uvx pre-commit run --all-files
```
## Daily Workflow (Working With Python Project Code)
VS Code should have only this project open.
Open a VS Code terminal (menu: `Terminal` / `New Terminal`) and run:
```shell
git pull
uv run python -m pro_analytics_02.demo_module_basics
# do chores
uv run ruff format .
uv run ruff check . --fix
uv run python -m pyright
uv run python -m pytest
uv run python -m zensical build
```
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.
```shell
git add -A
git commit -m "your message here"
git push -u origin main
```
## Tools
Core tools:
- `uv` for dependency management and command execution
- `ruff` for formatting and linting
- `pytest` for test execution
- `zensical` for documentation
## Annotations
[ANNOTATIONS.md](https://github.com/structural-explainability/.github/blob/main/ANNOTATIONS.md)
## Citation
[CITATION.cff](./CITATION.cff)
## License
[MIT](./LICENSE)
## SE Manifest
[SE_MANIFEST.toml](./SE_MANIFEST.toml)