public
/
cookiecutter-data-science
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README updates

This commit is contained in:
Peter Bull 2016-03-19 16:32:33 -04:00
parent 18e38f4164
commit 173a18ac88
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,6 +1,23 @@
cookiecutter-data-science
-------------------------
An opinionated, but not-afraid-to-be-wrong project template for data science projects. Pull requests welcome. Debate encouraged.
Requirements to create project:
-----------
- Python 2.7 or 3.5
- [cookiecutter Python package](http://cookiecutter.readthedocs.org/en/latest/installation.html)
To start a new project:
------------
cookiecutter git@github.com:drivendata/cookiecutter-data-science.git
Data
----------
** By default, the `data` folder is included in the `.gitignore` file.** If you have a small amount of data that rarely changes, you may want to include the data in the repository. Github currently warns if files are over 50MB and rejects files over 100MB. Some other options for storing large data include [AWS S3](https://aws.amazon.com/s3/) with a syncing tool (e.g., [`s3cmd`](http://s3tools.org/s3cmd)), [Git Large File Storage](https://git-lfs.github.com/), [Git Annex](https://git-annex.branchable.com/), and [dat](http://dat-data.com/).
The prefered workflow if data is not in the repository is to have a make command `make data` that will download or create the relevant datasets.