Browse Source

Initial gitignore and README

Update gitignore and README from other projects
master
Nate Bohman 3 years ago
parent
commit
3613959a49
Signed by: Nate Bohman <natrinicle@gmail.com> GPG Key ID: C10546A54ABA1CE5
2 changed files with 106 additions and 3 deletions
  1. +87
    -2
      .gitignore
  2. +19
    -1
      README.md

+ 87
- 2
.gitignore View File

# ---> 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 # Byte-compiled / optimized / DLL files
__pycache__/ __pycache__/
*.py[cod] *.py[cod]
sdist/ sdist/
var/ var/
wheels/ wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/ *.egg-info/
.installed.cfg .installed.cfg
*.egg *.egg
# Installer logs # Installer logs
pip-log.txt pip-log.txt
pip-delete-this-directory.txt pip-delete-this-directory.txt
pip-selfcheck.json


# Unit test / coverage reports # Unit test / coverage reports
htmlcov/ htmlcov/
.nox/ .nox/
.coverage .coverage
.coverage.* .coverage.*
docs/source/coverage/*
!docs/source/coverage/*.source.html
!docs/source/coverage/extract_source.py
docs/source/api/*
.cache .cache
nosetests.xml nosetests.xml
coverage.xml coverage.xml
*.cover *.cover
*.py,cover
.hypothesis/ .hypothesis/
.pytest_cache/ .pytest_cache/
.pylint.d/


# Translations # Translations
*.mo *.mo
*.log *.log
local_settings.py local_settings.py
db.sqlite3 db.sqlite3
db.sqlite3-journal
static/*
!static/.touch


# Flask stuff: # Flask stuff:
instance/ instance/


# Sphinx documentation # Sphinx documentation
docs/_build/ docs/_build/
docs/build/


# PyBuilder # PyBuilder
target/ target/
# pyenv # pyenv
.python-version .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 # celery beat schedule file
celerybeat-schedule celerybeat-schedule
celerybeat.pid


# SageMath parsed files # SageMath parsed files
*.sage.py *.sage.py


# Pyre type checker # Pyre type checker
.pyre/ .pyre/
####### Python End #######

+ 19
- 1
README.md View File

# cookiecutter-pypackage # 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.

Loading…
Cancel
Save