https://github.com/diogenesanalytics/cookiecutter-ds-gist
A logical, reasonably standardized, but flexible project structure for doing and sharing data science work (GIST version).
https://github.com/diogenesanalytics/cookiecutter-ds-gist
Last synced: 3 months ago
JSON representation
A logical, reasonably standardized, but flexible project structure for doing and sharing data science work (GIST version).
- Host: GitHub
- URL: https://github.com/diogenesanalytics/cookiecutter-ds-gist
- Owner: DiogenesAnalytics
- Created: 2024-05-10T20:28:57.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-03-05T14:06:18.000Z (over 1 year ago)
- Last Synced: 2025-03-21T17:55:47.830Z (over 1 year ago)
- Language: Makefile
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# About
*GIST* version of the
[cookiecutter-ds](https://github.com/DiogenesAnalytics/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