cookiecutter-data-science

(★ 10,013)

A logical, reasonably standardized, but flexible project structure for doing and sharing data science work.

Owner Repos

cloudpathlib ★ 626

Python pathlib-style classes for cloud storage services such as Amazon S3, Azure Blob Storage, and Google Cloud Storage.

Python
erdantic ★ 416

Entity relationship diagrams for Python data model classes like Pydantic

Python
competition-winners ★ 413

The code for the prize winners in DrivenData competitions.
concept-to-clinic ★ 366

ALCF Concept to Clinic Challenge

Python
deon ★ 310

A command line tool to easily add an ethics checklist to your data science projects.

Python
box-plots-sklearn ★ 296

An implementation of some of the tools used by the winner of the box plots competition using scikit-learn.

Jupyter Notebook

File Explorer

ZIP Download
  • .gitattributes
  • .gitignore
  • ccds-help.json
  • ccds.json
  • cookiecutter.json
  • dev-requirements.txt
  • HISTORY.md
  • LICENSE
  • Makefile
  • pyproject.toml
  • README.md
  • RELEASING.md
  • setup.cfg

# Installation Guide

python
Prerequisites

Setup Steps

pipx install cookiecutter-data-science

Install cookiecutter-data-science using pipx.

ccds

Create a new data science project.

Key Commands

pipx install cookiecutter-data-science

Install the CCDS package globally on the system.

ccds

Initialize a new data science project template.

ccds -c master

Create a project using a specific branch or version of the template.

pytest tests

Run the project tests.

You can run the ccds command alone or with options to generate the project template.

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Link
Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

pip freeze

View Details ▼

List installed packages in requirements format.

pip freeze

List installed packages:

pip freeze > requirements.txt

Write installed packages to the `requirements.txt` file:

pip freeze {{[-l|--local]}}

List installed packages in a virtual environment, excluding globally installed packages:

🔍

pip install

View Details ▼

Install Python packages.

pip install {{package1 package2 ...}}

Install one or more packages:

pip install {{package1 package2 ...}} {{[-U|--upgrade]}}

Upgrade all specified packages to the latest version, installing any that are not already present:

pip install {{package}}=={{version}}

Install a specific version of a package:

🔍

pipx

View Details ▼

Install and run Python applications in isolated environments.

pipx run {{pycowsay}} {{moo}}

Run an app in a temporary virtual environment:

pipx install {{package}}

Install a package in a virtual environment and add entry points to path:

pipx uninstall {{package}}

Uninstall a package:

🔍

pytest

View Details ▼

Run Python tests.

pytest {{path/to/test_file1.py path/to/test_file2.py ...}}

Run tests from specific files:

pytest -k {{expression}}

Run tests with names matching a specific [k]eyword expression:

pytest {{[-x|--exitfirst]}}

Exit as soon as a test fails or encounters an error:

// repository documentation