DiogenesAnalytics / cookiecutter-ds-gist

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

About

GIST version of the cookiecutter-ds template.

Usage

The following Docker command can be executed to use this cookiecutter template:

docker run --rm \
           -v $PWD:/home/jovyan/ \
           -it \
             ghcr.io/diogenesanalytics/analytics-notebook:master \
               cookiecutter \
               gh:diogenesanalytics/cookiecutter-ds-gist

Make

Here we will document the different make commands defined in the Makefile. All commands (excluding the all command which is simply executed by running make) are executed by the following format: make [COMMAND]. To see the contents of a command that will be executed upon invocation of the command, simply run make -n [COMMAND].

Commands

• all: (aka: make) alias for jupyter command
• jupyter: launches the Jupyter notebook development Docker image
• pause: pause PSECS (to pause between commands)
• address: get Docker container address/port
• containers: launch all Docker containers
• list-containers: list all running containers
• stop-containers: simply stops all running Docker containers
• restart-containers: restart all containers
• clear-nb: simply clears Jupyter notebook output
• clean: combines all clearing commands into one