v1.0.0

Data science project template

A modern template for data science projects with all the necessary tools for experiment, development, testing, and deployment. From notebooks to production.

https://joserzapata.github.io/data-science-project-template/

Features

• Dependency management with UV
• Virtual environment management with UV
• Linting with pre-commit and Ruff
• Continuous integration with GitHub Actions
• Documentation with mkdocs and mkdocstrings using the mkdocs-materialtheme
• Automated dependency updates with Dependabot
• Code formatting with Ruff
• Import sorting with Ruff using isort rule.
• Testing with pytest
• Code coverage with Coverage.py
• Coverage reporting with Codecov
• Static type-checking with mypy
• Security audit with Ruff using bandit rule.
• Manage project labels with GitHub Labeler

What's Changed

• pre-commit update github action by @JoseRZapata in #1
• add pre-commit autoupdate to github actions by @JoseRZapata in #2
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #3
• chore(pre-commit): auto update hooks by @JoseRZapata in #4
• chore(pre-commit): auto update hooks by @JoseRZapata in #5
• [Actions] Auto-Update dependencies by @JoseRZapata in #6
• chore(pre-commit): auto update hooks by @JoseRZapata in #7
• [Actions] Auto-Update dependencies by @JoseRZapata in #8
• 📝 Feature/update_readme by @JoseRZapata in #9
• Feature/github_page by @JoseRZapata in #10
• Feature/fix_gh_page by @JoseRZapata in #11
• chore(pre-commit): auto update hooks by @JoseRZapata in #12
• Add vscode and pre-commit configuration by @JoseRZapata in #13
• Bump actions/checkout from 3 to 4 by @dependabot in #14
• Bump mkdocs-material from 9.5.5 to 9.5.6 by @dependabot in #15
• add_docs_GH_actions by @JoseRZapata in #16
• Bump mkdocs-material from 9.5.6 to 9.5.7 by @dependabot in #17
• chore(pre-commit): auto update hooks by @JoseRZapata in #18
• Feature/update_cookiecutter by @JoseRZapata in #20
• cookiecutter tests by @JoseRZapata in #21
• ✅ update mkdocs test by @JoseRZapata in #25
• Feature/check_python by @JoseRZapata in #26
• Bump actions/checkout from 2 to 4 by @dependabot in #22
• Bump pre-commit from 3.6.0 to 3.6.1 by @dependabot in #24
• Bump mkdocs-material from 9.5.7 to 9.5.9 by @dependabot in #23
• remove automatic git init by @JoseRZapata in #27
• 🔧 Remove mkdocs based on template by @JoseRZapata in #28
• Bump pre-commit from 3.6.1 to 3.6.2 by @dependabot in #29
• chore(pre-commit): auto update hooks by @JoseRZapata in #32
• Bump mkdocs-material from 9.5.9 to 9.5.10 by @dependabot in #30
• chore(pre-commit): auto update hooks by @JoseRZapata in #38
• Bump mkdocstrings from 0.24.0 to 0.24.1 by @dependabot in #35
• Bump pymdown-extensions from 10.7 to 10.7.1 by @dependabot in #39
• chore(pre-commit): auto update hooks by @JoseRZapata in #43
• pre-commit replace bandit with ruff by @JoseRZapata in #45
• 🗃️ Add project directory structure by @JoseRZapata in #47
• Add issue templates by @JoseRZapata in #48
• ⬆ Bump the python-packages group with 3 updates by @dependabot in #52
• chore(pre-commit): auto update hooks by @JoseRZapata in #53
• ⬆ Bump the python-packages group with 2 updates by @dependabot in #54
• chore(pre-commit): auto update hooks by @JoseRZapata in #55
• ⬆ Bump peaceiris/actions-gh-pages from 3 to 4 by @dependabot in #57
• ⬆ Bump idna from 3.6 to 3.7 by @dependabot in #56
• ⬆ Bump the python-packages group with 2 updates by @dependabot in #58
• chore(pre-commit): auto update hooks by @JoseRZapata in #59
• chore(pre-commit): auto update hooks by @JoseRZapata in #61
• ⬆ Bump the python-packages group with 5 updates by @dependabot in #60
• ⬆ Bump the python-packages group with 2 updates by @dependabot in #62
• chore(pre-commit): auto update hooks by @JoseRZapata in #63
• chore(pre-commit): auto update hooks by @JoseRZapata in #64
• chore(pre-commit): auto update hooks by @JoseRZapata in #66
• ⬆ Bump the python-packages group with 2 updates by @dependabot in #65
• chore(pre-commit): auto update hooks by @JoseRZapata in #68
• ⬆ Bump the python-packages group with 2 updates by @dependabot in #67
• ⬆ Bump requests from 2.31.0 to 2.32.0 in the pip group by @dependabot in #69
• chore(pre-commit): auto update hooks by @JoseRZapata in #71
• ⬆ Bump mkdocs-material from 9.5.23 to 9.5.24 in the python-packages group by @dependabot in #70
• chore(pre-commit): auto update hooks by @JoseRZapata in https://github.com/JoseRZapata/d...