This project can be used as a starter for future Python projects. It contains the setup and configuration files for documentation with readthedocs, automated testing with TravisCI, and installation with pip.
A Python package can be locally "installed" using pip with this command:
pip install -e <path to package>List the packages and specific version numbers that you use.
This template project is configured to produce API documentation as prepared in docstrings. Docstrings should conform to the Google style guide as much as possible.
A readthedocs config file is included at python_template/.readthedocs.yml which contains default settings for a connection to readthedocs. See the readthedocs config documentation for more details.
All tests should be contained in the python_template/tests directory and reference the module files in python_template/src.
A config file for TravisCI is included at python_template/.travis.yml.
There are some files that will be particular to you project and will need customization.
This is the configuration file for debugging in Visual Studio Code. Each language has a unique syntax for the debugger setup. Included here is the Python version.
{
"name": "test 1",
"type": "python",
"request": "launch",
"stopOnEntry": false,
"pythonPath": "${config:python.pythonPath}",
"program": "${workspaceRoot}/examples/example_script.py",
"cwd": "${workspaceRoot}/examples",
},Other files contained in this package