python mother dough starter

python-mother-dough/README.md

@@ -0,0 +1,29 @@
+# Mother Dough
+
+A mother dough for baking the most delicious python project.
+Inspired by [Kenneth's blog](https://www.kennethreitz.org/essays/repository-structure-and-python).
+
+## Structure 
+TODO: describe file structure here
+
+How should I name directories and packages?
+[PEP8](https://www.python.org/dev/peps/pep-0008/#package-and-module-names) discourages the use of underscores in package names.
+Although Guido in the [Google Style doc](https://google.github.io/styleguide/pyguide.html?showone=Naming#Naming) recommends underscores for longer names. In either case, packages should be lowercase.
+
+## Setup.py
+
+Why bother? [setup.py](http://setuptools.readthedocs.io/en/latest/setuptools.html#basic-use) allows you to pip install your repo as a package so you can test and reuse code across your module without relative paths. For example, 
+`from motherdough import ferment` works anywhere in your project (even tests). To install your repo as a package, run:
+
+```bash
+pip install -e .
+```
+pip uses the setup.py file settings to install the package.
+
+## Development Style Guide
+
+A good set of [best practices](https://gist.github.com/sloria/7001839) to follow
+
+### Automatic Style Checks
+* [pycodestyle](https://github.com/PyCQA/pycodestyle): enforces PEP8, without being too picky.
+* [pylint](https://www.pylint.org/): covers much more than PEP8, but is absurdly picky out-of-the-box (not always with good reason).

python-mother-dough/another/hi.py

@@ -0,0 +1,2 @@
+def howdy():
+    return "hi"

python-mother-dough/motherdough/ferment.py

@@ -0,0 +1,2 @@
+def ferment():
+    return "fermented"

python-mother-dough/setup.py

@@ -0,0 +1,11 @@
+"""
+Describes code as a package that pip can install
+"""
+
+from setuptools import setup, find_packages
+
+setup(
+    # does not impact import name
+    name='python-mother-dough' 
+    packages=find_packages(exclude=('tests', 'docs')),
+)