{"id":50508871,"url":"https://github.com/denisecase/pro-analytics-02","last_synced_at":"2026-06-02T18:31:13.629Z","repository":{"id":319739976,"uuid":"1076981961","full_name":"denisecase/pro-analytics-02","owner":"denisecase","description":"Professional Python project starter and guide using uv, Ruff, MkDocs, and GitHub Actions (2026)","archived":false,"fork":false,"pushed_at":"2026-05-20T18:01:57.000Z","size":1424,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-20T22:05:50.967Z","etag":null,"topics":["automation","ci","data-analytics","deploy","documentation","github-actions","mkdocs","professional","project","python","ruff","uv"],"latest_commit_sha":null,"homepage":"https://denisecase.github.io/pro-analytics-02/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/denisecase.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-10-15T15:55:48.000Z","updated_at":"2026-05-20T18:02:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"df833751-fc7f-47fa-8e77-4e9a5e506f78","html_url":"https://github.com/denisecase/pro-analytics-02","commit_stats":null,"previous_names":["denisecase/pro-analytics-02"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/denisecase/pro-analytics-02","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denisecase%2Fpro-analytics-02","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denisecase%2Fpro-analytics-02/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denisecase%2Fpro-analytics-02/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denisecase%2Fpro-analytics-02/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/denisecase","download_url":"https://codeload.github.com/denisecase/pro-analytics-02/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denisecase%2Fpro-analytics-02/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33833277,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-02T02:00:07.132Z","response_time":109,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","ci","data-analytics","deploy","documentation","github-actions","mkdocs","professional","project","python","ruff","uv"],"created_at":"2026-06-02T18:31:12.617Z","updated_at":"2026-06-02T18:31:13.621Z","avatar_url":"https://github.com/denisecase.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pro Analytics 02\n\n[![Docs Site](https://img.shields.io/badge/docs-site-blue?logo=github)](https://denisecase.github.io/pro-analytics-02/)\n[![Python 3.14+](https://img.shields.io/badge/python-3.14%2B-blue?logo=python)](https://github.com/denisecase/pro-analytics-02/blob/main/pyproject.toml)\n[![CI Status](https://github.com/denisecase/pro-analytics-02/actions/workflows/ci-python-zensical.yml/badge.svg?branch=main)](https://github.com/denisecase/pro-analytics-02/actions/workflows/ci-python-zensical.yml)\n[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)\n\n[![CI](https://github.com/denisecase/pro-analytics-02/actions/workflows/ci-python-zensical.yml/badge.svg?branch=main)](https://github.com/denisecase/pro-analytics-02/actions/workflows/ci-python-zensical.yml)\n[![Docs](https://github.com/denisecase/pro-analytics-02/actions/workflows/deploy-zensical.yml/badge.svg?branch=main)](https://github.com/denisecase/pro-analytics-02/actions/workflows/deploy-zensical.yml)\n[![Links](https://github.com/denisecase/pro-analytics-02/actions/workflows/links.yml/badge.svg?branch=main)](https://github.com/denisecase/pro-analytics-02/actions/workflows/links.yml)\n[![Dependabot](https://img.shields.io/badge/Dependabot-enabled-brightgreen.svg)](https://github.com/denisecase/pro-analytics-02/security)\n\n\u003e Professional Python project starter and guide.\n\n\u003c!--\nREQ: Title, badges, and positioning statement appear before anything else.\nWHY: README opens with exactly one page title, credibility signals, then a concise scope statement.\n--\u003e\n\n## Overview and Scope\n\nThis repository serves two purposes:\n\n1. A **ready-to-use starter repository** for professional Python projects\n2. A **reference guide** for modern Python workflows\n\nIt demonstrates a professional Python project structure, tooling configuration, and documentation practices.\n\n## Documentation Site\n\nThis repository includes an associated\n[**documentation site**](https://denisecase.github.io/pro-analytics-02/).\n\n## Developers and Maintainers\n\nThis is a reference site. Most people do not need to get this running on their machine.\nFor developers and maintainers (or if you want to fork your own copy).\n\n### Set Up Machine\n\n- Complete 🟢\n[Workflow A. Set Up Machine](https://denisecase.github.io/pro-analytics-02/workflow-a-set-up-machine/)\nto **set up a machine** for Python development.\n\n### Copy \u0026 Open this Project in VS Code\n\n1. Sign in to GitHub, open this repository in your browser.\n2. Click **Copy this template** to get a copy in **YOURACCOUNT**.\n3. Enable GitHub Pages.\n\nOpen a terminal on your machine (not VS Code) in your Repos folder and run:\n\n```shell\ngit clone https://github.com/YOURACCOUNT/pro-analytics-02\n\ncd pro-analytics-02\ncode .\n```\n\nWhen VS Code opens, accept the Extension Recommendations (click **`Install All`** or similar when asked).\n\n### Create and Manage the Project Environment\n\nUse VS Code menu option `Terminal` / `New Terminal` to open a\n**VS Code terminal** in the root project folder.\n\nTo set up a project Python environment (managed by `uv`) and align VS Code with it,\nrun the following commands, one at a time, hitting ENTER after each:\n\n```shell\n# reset uv cache if strange dependency errors appear\n# del .venv\n# uv cache clean\n\nuv self update\nuv python pin 3.14\nuv sync --extra dev --extra docs --upgrade\n```\n\nIf asked: \"We noticed a new environment has been created.\nDo you want to select it for the workspace folder?\" Click **\"Yes\"**.\n\nIf successful, you'll see a new `.venv` folder appear in the root project folder.\n\nInstall and run pre-commit checks (twice if necessary as shown below):\n\n```shell\nuvx pre-commit install\n\ngit add -A\nuvx pre-commit run --all-files\n# repeat if changes were made\ngit add -A\nuvx pre-commit run --all-files\n```\n\n## Daily Workflow (Working With Python Project Code)\n\nVS Code should have only this project open.\nOpen a VS Code terminal (menu: `Terminal` / `New Terminal`) and run:\n\n```shell\ngit pull\n\nuv run python -m pro_analytics_02.demo_module_basics\n\n# do chores\nuv run ruff format .\nuv run ruff check . --fix\nuv run python -m pyright\nuv run python -m pytest\nuv run python -m zensical build\n```\n\nWhile editing project code and docs, repeat the commands above to\nrun files, check them, and rebuild docs as needed.\n\nSave progress frequently.\nSome tools may make changes;\nyou may need to **re-run git `add` and `commit`** to ensure everything gets committed before pushing.\n\n```shell\ngit add -A\ngit commit -m \"your message here\"\ngit push -u origin main\n```\n\n## Tools\n\nCore tools:\n\n- `uv` for dependency management and command execution\n- `ruff` for formatting and linting\n- `pytest` for test execution\n- `zensical` for documentation\n\n## Annotations\n\n[ANNOTATIONS.md](https://github.com/structural-explainability/.github/blob/main/ANNOTATIONS.md)\n\n\u003c!--\nWHY: Keep decision rationale close to code and configuration.\n--\u003e\n\n## Citation\n\n[CITATION.cff](./CITATION.cff)\n\n\u003c!--\nWHY: Support correct citation and attribution.\n--\u003e\n\n## License\n\n[MIT](./LICENSE)\n\n\u003c!--\nWHY: Provide terms of reuse and limits of liability.\n--\u003e\n\n## SE Manifest\n\n[SE_MANIFEST.toml](./SE_MANIFEST.toml)\n\n\u003c!--\nWHY: Make explicit the intent, boundaries, and scope of this repository.\n--\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdenisecase%2Fpro-analytics-02","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdenisecase%2Fpro-analytics-02","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdenisecase%2Fpro-analytics-02/lists"}