https://github.com/statcan/datascience-cookiecutter
A Cookiecutter template for Data Science Projects in Python
https://github.com/statcan/datascience-cookiecutter
Last synced: 8 months ago
JSON representation
A Cookiecutter template for Data Science Projects in Python
- Host: GitHub
- URL: https://github.com/statcan/datascience-cookiecutter
- Owner: StatCan
- License: mit
- Created: 2021-11-24T14:05:43.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-21T00:57:57.000Z (over 2 years ago)
- Last Synced: 2025-07-15T07:03:37.909Z (8 months ago)
- Language: Python
- Size: 111 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
[(Français)](#le-nom-du-projet)
## StatCan Data Science Cookiecutter
A ``cookiecutter`` template for data science projects within Statistics Canada and wider public sector. The goal is to reduce the amount of set up tasks associated with starting data science projects at Statistics Canada.
This template helps to set up standardized project, and includes security features using pre-commit hooks.
See [usage](docs/usage.rst) to get started.
### How to Contribute
See [CONTRIBUTING.md](CONTRIBUTING.md)
### License
Unless otherwise noted, the source code of this project is covered under Crown Copyright, Government of Canada, and is distributed under the [MIT License](LICENSE).
The Canada wordmark and related graphics associated with this distribution are protected under trademark law and copyright law. No permission is granted to use them outside the parameters of the Government of Canada's corporate identity program. For more information, see [Federal identity requirements](https://www.canada.ca/en/treasury-board-secretariat/topics/government-communications/federal-identity-requirements.html).
### Acknowledgements
This template is inspired by the work of the [DrivenData cookiecutter data science project](http://drivendata.github.io/cookiecutter-data-science/),
as well as the United Kingdom [govcookiecutter](https://github.com/best-practice-and-impact/govcookiecutter). Specifically, the `data` directory layout and `help` command in the
`Makefile`s.
______________________
## Cookiecutter pour les projets de science des données à StatCan
Un gabarit ``cookiecutter`` pour les projets de science des données à Statistique Canada et dans le secteur public en général. L'objectif est de réduire le nombre de tâches de mise en place associées au démarrage de projets de science des données à Statistique Canada.
Ce modèle aide à mettre en place un projet standardisé et comprend des fonctions de sécurité utilisant des crochets de pré-commit.
Voir [l'utilisation](docs/usage.rst) pour commencer.
### Comment contribuer
Voir [CONTRIBUTING.md](CONTRIBUTING.md)
### Licence
Sauf indication contraire, le code source de ce projet est protégé par le droit d'auteur de la Couronne du gouvernement du Canada et distribué sous la [licence MIT](LICENSE).
Le mot-symbole « Canada » et les éléments graphiques connexes liés à cette distribution sont protégés en vertu des lois portant sur les marques de commerce et le droit d'auteur. Aucune autorisation n'est accordée pour leur utilisation à l'extérieur des paramètres du programme de coordination de l'image de marque du gouvernement du Canada. Pour obtenir davantage de renseignements à ce sujet, veuillez consulter les [Exigences pour l'image de marque](https://www.canada.ca/fr/secretariat-conseil-tresor/sujets/communications-gouvernementales/exigences-image-marque.html).
### Remerciements
Ce modèle s'inspire des travaux du [projet de science des données DrivenData cookiecutter](http://drivendata.github.io/cookiecutter-data-science/),
ainsi que du projet britannique [govcookiecutter] (https://github.com/best-practice-and-impact/govcookiecutter). Plus précisément, la disposition du répertoire `data` et la commande `help` dans les fichiers `Makefile`s.