Commit 8ea9bc2a authored by Mitchell Murphy's avatar Mitchell Murphy
Browse files

base template created, without testing

parents
The MIT License (MIT)
Copyright (c) 2016 DrivenData, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
# DS Workflow
A standardised workflow for Data Science projects.
## Getting Started
### Prerequisites
* [Python3](https://www.python.org/downloads/)
### Installing
Install cookiecutter:
```
pip3 install cookiecutter==1.6.0
```
Create your project with the data science template:
```
cookiecutter https://gitlab.com/mwtmurphy/ds-workflow
```
## Running Tests (TBC)
## Authors
* **Mitchell Murphy**
* Creator & Maintainer
## License
This project is licensed under the [MIT License](./LICENSE)
## Acknowledgements
This project is heavily inspired by [Cookiecutter Data Science](https://drivendata.github.io/cookiecutter-data-science/), whereby this version can be seen as a personalisation of the cookiecutter template, in order to:
* Exemplify my process
* Provide a more relevant template for the tools/approach I utlise
\ No newline at end of file
{
"project_title": "project title",
"repo_name": "{{cookiecutter.project_title.lower().replace(' ', '-'}}",
"project_description": "short description for project",
"project_author": "project author"
}
\ No newline at end of file
### Boilerplate Python gitignore ###
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
target/
# Jupyter Notebook
.ipynb_checkpoints
# pyenv
.python-version
# celery beat schedule file
celerybeat-schedule
# SageMath parsed files
*.sage.py
# Environments
.env
venv/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
### Additional Files ###
# Mac Finder styling
.DS_Store
\ No newline at end of file
VENV_DIR ?= venv
PYTHON = $(VENV_DIR)/bin/python
pyenv: requirements.txt
pip3 install virtualenv
test -d venv || python3 -m virtualenv venv
$(VENV_DIR)/bin/pip install -r requirements.txt
# {{cookiecutter.project_title}}
{{cookiecutter.project_description}}
## Project Architecture
├── LICENSE
├── Makefile <- Makefile with DS shortcut commands
├── README.md <- The top-level README for developers using this project.
├── data
│ ├── external <- Data from third party sources.
│ ├── interim <- Intermediate data that has been transformed.
│ ├── processed <- The final, canonical data sets for modeling.
│ └── raw <- The original, immutable data dump.
├── models <- Trained and serialized models, model predictions, or model summaries
├── research <- Jupyter notebooks and scripts used in project research, following naming
│ convention: `_` delimited description with an appended [semantic version](https://semver.org/)
│ number e.g. `data_exploration_1_0_0`.
├── dictionary <- Terminology, manuals, and all other explanatory materials
├── reports <- Generated analysis as HTML, PDF, LaTeX, etc.
│ └── figures <- Generated graphics and figures to be used in reporting
├── requirements.txt <- Requirements file for reproducing the analysis environment
├── setup.py <- Setup file making `src` importable (pip install -e .)
└── src <- Tailormade source code for use in this project
├── data <- Scripts to download or generate data
├── features <- Scripts to turn raw data into features for modeling
├── models <- Scripts to train/utilise models
└── visualisation <- Scripts to create exploratory and results oriented visualisations
## Getting Started
~~~ A guide to getting this project up and running on a local machine ~~~
### Prerequisites
~~~ Software needed to be installed and how to install it ~~~
### Installing
~~~ A step-by-step guide to getting a development environment running ~~~
## Running Tests
~~~ Explain the automated tests for this project ~~~
## Authors
* **{{cookiecutter.project_author}}**
* Creator & Maintainer
## License
~~~ Reference to the license - or absence of - in this project ~~~
## Acknowledgements
~~~ A hat tip to any research, inspiration, code, etc. used in this project ~~~
\ No newline at end of file
pandas
matplotlib
jupyter
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment