Initial gitignore and README

Update gitignore and README from other projects

.gitignore

@@ -1,4 +1,65 @@
-# ---> Python
+####### IDE Start #######
+# Webstorm
+.idea/
+####### IDE End #######
+
+####### MacOS Start #######
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+####### MacOS End #######
+
+####### Windows Start #######
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+####### Windows End #######
+
+####### Python Start #######
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -21,6 +82,8 @@ parts/
 sdist/
 var/
 wheels/
+pip-wheel-metadata/
+share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
@@ -35,6 +98,7 @@ MANIFEST
 # Installer logs
 pip-log.txt
 pip-delete-this-directory.txt
+pip-selfcheck.json
 
 # Unit test / coverage reports
 htmlcov/
@@ -42,12 +106,18 @@ htmlcov/
 .nox/
 .coverage
 .coverage.*
+docs/source/coverage/*
+!docs/source/coverage/*.source.html
+!docs/source/coverage/extract_source.py
+docs/source/api/*
 .cache
 nosetests.xml
 coverage.xml
 *.cover
+*.py,cover
 .hypothesis/
 .pytest_cache/
+.pylint.d/
 
 # Translations
 *.mo
@@ -57,6 +127,9 @@ coverage.xml
 *.log
 local_settings.py
 db.sqlite3
+db.sqlite3-journal
+static/*
+!static/.touch
 
 # Flask stuff:
 instance/
@@ -67,6 +140,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/build/
 
 # PyBuilder
 target/
@@ -81,8 +155,19 @@ ipython_config.py
 # pyenv
 .python-version
 
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
 # celery beat schedule file
 celerybeat-schedule
+celerybeat.pid
 
 # SageMath parsed files
 *.sage.py
@@ -113,4 +198,4 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
-
+####### Python End #######

README.md

@@ -1,3 +1,21 @@
 # cookiecutter-pypackage
+Generate a Python package project using the Python Cookiecutter package
 
-Generate a Python package project using the Python Cookiecutter package
+## Usage
+Generate a Python package project:
+
+```
+cookiecutter https://git.natrinicle.com/natrinicle/cookiecutter-pypackage.git
+```
+
+About the package requirements:
+
+    Install the dev requirements in your local machine by running:
+
+    pip install -r requirements/dev.txt
+
+    Requirements for Unit testing can be found in requirements/test.txt
+
+    Requirements for Prod build can be found in requirements/prod.txt
+
+    Prod requirements are reused in both Dev and Test requirements.