Support cookiecutter

Author: mana-ysh

.github/workflows/pythonpackage.yml

@@ -26,14 +26,8 @@ jobs:
  - name: Install dependencies
  run: |
  python -m pip install --upgrade pip
- pip install flake8 pytest mypy
+ pip install cookiecutter flake8 pytest mypy
  pip install .
- - name: Lint
+ - name: CI
  run: |
- make lint
- - name: Test
- run: |
- make test
- - name: Type checking
- run: |
- make typecheck
+ make create-project-no-input && make ci

Makefile

@@ -1,40 +1,18 @@
 
-##### docker
-IMAGE_NAME := python-api-template
-CONTAINER_NAME := ${IMAGE_NAME}-container
-SRC_PORT := 4600
-DST_PORT := 9876
+PROJECT_NAME := manaysh_api
+DESCRIPTION := hoge
 
-build-image:
-docker build -t ${IMAGE_NAME} ./
+##### cookiecutter
+create-project:
+cookiecutter ./
 
-run-container:
-docker run -it -d \
---name ${CONTAINER_NAME} \
--p ${SRC_PORT}:${DST_PORT} \
-${IMAGE_NAME}
+create-project-no-input:
+cookiecutter --no-input ./ \
+project_slug=${PROJECT_NAME} \
+description=${DESCRIPTION}
 
-##### ci
-ci: typecheck test lint
+ci:
+cd ${PROJECT_NAME} && make ci
 
-typecheck:
-@echo check types
-mypy ./python_api_template
-
-lint:
-@echo check style
-flake8 --show-source --statistics
-
-test:
-@echo testing
-pytest -rf --cov=./python_api_template
-
-
-##### application
-GUNICORN_CONFIG_PATH := config/gunicorn.py
-
-launch:
-gunicorn app:app -c ${GUNICORN_CONFIG_PATH}
-
-launch-develop:
-python app.py
+clean:
+rm -rf ${PROJECT_NAME}

cookiecutter.json

@@ -0,0 +1,4 @@
+{
+ "project_slug": "python_api_template",
+ "description": "hoge"
+}

.coveragerc renamed to {{ cookiecutter.project_slug }}/.coveragerc

@@ -0,0 +1,41 @@
+{% raw -%}
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python package
+
+on:
+ push:
+ branches: [ master ]
+ pull_request:
+ branches: [ master ]
+
+jobs:
+ build:
+
+ runs-on: ubuntu-latest
+ strategy:
+ matrix:
+ python-version: [3.7, 3.8]
+
+ steps:
+ - uses: actions/checkout@v2
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v1
+ with:
+ python-version: ${{ matrix.python-version }}
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install flake8 pytest mypy
+ pip install .
+ - name: Lint
+ run: |
+ make lint
+ - name: Test
+ run: |
+ make test
+ - name: Type checking
+ run: |
+ make typecheck
+{%- endraw %}

.flake8 renamed to {{ cookiecutter.project_slug }}/.flake8

@@ -0,0 +1,129 @@
+# 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/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+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 stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

{{ cookiecutter.project_slug }}/.github/workflows/pythonpackage.yml

@@ -13,8 +13,6 @@ COPY . /app
 
 WORKDIR /app
 
-# update to avoid 'setup.py' not found error
-# RUN pip3 install -U pip
 RUN pip3 install .
 
 RUN rm -rf /var/lib/apt/lists/*

{{ cookiecutter.project_slug }}/.gitignore

@@ -0,0 +1,39 @@
+##### docker
+IMAGE_NAME := {{ cookiecutter.project_slug }} 
+CONTAINER_NAME := ${IMAGE_NAME}-container
+SRC_PORT := 4600
+DST_PORT := 9876
+
+build-image:
+docker build -t ${IMAGE_NAME} ./
+
+run-container:
+docker run -it -d \
+--name ${CONTAINER_NAME} \
+-p ${SRC_PORT}:${DST_PORT} \
+${IMAGE_NAME}
+
+##### ci
+ci: typecheck test lint
+
+typecheck:
+@echo check types
+mypy ./{{ cookiecutter.project_slug }} 
+
+lint:
+@echo check style
+flake8 --show-source --statistics
+
+test:
+@echo testing
+pytest -rf --cov=./{{ cookiecutter.project_slug }} 
+
+
+##### application
+GUNICORN_CONFIG_PATH := config/gunicorn.py
+
+launch:
+gunicorn app:app -c ${GUNICORN_CONFIG_PATH}
+
+launch-develop:
+python app.py