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 #73
• ⬆ Bump mkdocs-material from 9.5.24 to 9.5.25 in the python-packages group by @dependabot in #72
• chore(pre-commit): auto update hooks by @JoseRZapata in #75
• ⬆ Bump the python-packages group with 2 updates by @dependabot in #74
• chore(pre-commit): auto update hooks by @JoseRZapata in #77
• ⬆ Bump mkdocs-material from 9.5.26 to 9.5.27 in the python-packages group by @dependabot in #76
• ⬆ Bump urllib3 from 2.2.1 to 2.2.2 in the pip group by @dependabot in #78
• chore(pre-commit): auto update hooks by @JoseRZapata in #79
• chore(pre-commit): auto update hooks by @JoseRZapata in #80
• ⬆ Bump certifi from 2024.2.2 to 2024.7.4 in the pip group by @dependabot in #81
• chore(pre-commit): auto update hooks by @JoseRZapata in #83
• ⬆ Bump mkdocs-material from 9.5.27 to 9.5.28 in the python-packages group by @dependabot in #82
• 🔥 remove test of make file by @JoseRZapata in #85
• ⬆ Bump zipp from 3.18.1 to 3.19.1 in the pip group by @dependabot in #84
• chore(pre-commit): auto update hooks by @JoseRZapata in #87
• ⬆ Bump mkdocs-material from 9.5.28 to 9.5.29 in the python-packages group by @dependabot in #86
• chore(pre-commit): auto update hooks by @JoseRZapata in #89
• ⬆ Bump pytest from 8.2.2 to 8.3.1 in the python-packages group by @dependabot in #88
• chore(pre-commit): auto update hooks by @JoseRZapata in #91
• ⬆ Bump the python-packages group with 5 updates by @dependabot in #90
• chore(pre-commit): auto update hooks by @JoseRZapata in #93
• ⬆ Bump mkdocs-material from 9.5.30 to 9.5.31 in the python-packages group by @dependabot in #92
• chore(pre-commit): auto update hooks by @JoseRZapata in #94
• chore(pre-commit): auto update hooks by @JoseRZapata in #95
• chore(pre-commit): auto update hooks by @JoseRZapata in #97
• ⬆ Bump mkdocs-material from 9.5.31 to 9.5.33 in the python-packages group by @dependabot in #96
• chore(pre-commit): auto update hooks by @JoseRZapata in #99
• ⬆ Bump the python-packages group with 3 updates by @dependabot in #98
• chore(pre-commit): auto update hooks by @JoseRZapata in #101
• ⬆ Bump mkdocstrings from 0.26.0 to 0.26.1 in the python-packages group by @dependabot in #100
• chore(pre-commit): auto update hooks by @JoseRZapata in #103
• ⬆ Bump pytest from 8.3.2 to 8.3.3 in the python-packages group by @dependabot in #102
• chore(pre-commit): auto update hooks by @JoseRZapata in #106
• ⬆ Bump the python-packages group with 2 updates by @dependabot in #105
• ⬆ Bump pascalgn/automerge-action from 0.16.3 to 0.16.4 by @dependabot in #104
• 📝 change pipx for UV by @JoseRZapata in #107
• chore(pre-commit): auto update hooks by @JoseRZapata in #109
• ⬆ Bump the python-packages group with 2 updates by @dependabot in #108
• chore(pre-commit): auto update hooks by @JoseRZapata in #111
• ⬆ Bump the python-packages group with 2 updates by @dependabot in #110
• ⬆ Bump the python-packages group with 3 updates by @dependabot in #112
• chore(pre-commit): auto update hooks by @JoseRZapata in #114
• ⬆ Bump mkdocs-material from 9.5.40 to 9.5.42 in the python-packages group by @dependabot in #113
• chore(pre-commit): auto update hooks by @JoseRZapata in #115
• chore(pre-commit): auto update hooks by @JoseRZapata in #117
• ⬆ Bump the python-packages group with 3 updates by @dependabot in #116
• chore(pre-commit): auto update hooks by @JoseRZapata in #119
• ⬆ Bump the python-packages group with 2 updates by @dependabot in #118
• chore(pre-commit): auto update hooks by @JoseRZapata in #121
• ⬆ Bump codecov/codecov-action from 4 to 5 by @dependabot in #120
• chore(pre-commit): auto update hooks by @JoseRZapata in #123
• ⬆ Bump mkdocs-material from 9.5.44 to 9.5.45 in the python-packages group by @dependabot in #122
• Feature/length ruff by @JoseRZapata in #124
• chore(pre-commit): auto update hooks by @JoseRZapata in #126
• ⬆ Bump the python-packages group with 2 updates by @dependabot in #125
• chore(pre-commit): auto update hooks by @JoseRZapata in #128
• ⬆ Bump mkdocs-material from 9.5.47 to 9.5.48 in the python-packages group by @dependabot in #127
• chore(pre-commit): auto update hooks by @JoseRZapata in #129
• chore(pre-commit): auto update hooks by @JoseRZapata in #131
• ⬆ Bump mkdocs-material from 9.5.48 to 9.5.49 in the python-packages group by @dependabot in #130
• ⬆ Bump jinja2 from 3.1.4 to 3.1.5 in the pip group by @dependabot in #132
• ⬆ Bump pymdown-extensions from 10.12 to 10.13 in the python-packages group by @dependabot in #133
• chore(pre-commit): auto update hooks by @JoseRZapata in #135
• pyenv and poetry to UV by @JoseRZapata in #134
• Docs/update info by @JoseRZapata in #137

New Contributors

• @JoseRZapata made their first contribution in #1
• @pre-commit-ci made their first contribution in #3
• @dependabot made their first contribution in #14

Full Changelog: https://github.com/JoseRZapata/data-science-project-template/commits/v1.0.0