Python project template

This repository is base project template for python

Features

Continuous Integration (CI)

• Formating
• Linting
• Unit testing
• API document generation
• GitHub action

Docker support

git clone https://github.com/j-marple-dev/python_template.git
cd python_template
./run_docker.sh build
# You can add build options
# ./run_docker.sh build --no-cache

./run_docker.sh run
# You can add running options
# ./run_docker.sh run -v $DATA_PATH:/home/user/data

# Re-run last docker container
./run_docker.sh exec

Setting environment

git clone https://github.com/j-marple-dev/python_template.git
cd python_template
./run_check.sh init_conda
./run_check.sh init_precommit  # Developer only

Developers

• Please refer to CODE_OF_CONDUCT guide.