Skip to content

A Cookiecutter template for Data Science Projects in Python

License

Notifications You must be signed in to change notification settings

StatCan/datascience-cookiecutter

Repository files navigation

(Français)

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 to get started.

How to Contribute

See 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.

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.

Acknowledgements

This template is inspired by the work of the DrivenData cookiecutter data science project, as well as the United Kingdom govcookiecutter. Specifically, the data directory layout and help command in the Makefiles.


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 pour commencer.

Comment contribuer

Voir 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.

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.

Remerciements

Ce modèle s'inspire des travaux du projet de science des données DrivenData cookiecutter, 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 Makefiles.

About

A Cookiecutter template for Data Science Projects in Python

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published