README_orig.md

Python Template

This repository is meant to establish useful practices for python projects.

Installation

See CONTRIBUTING.md for installation instructions.

To Dos

The following actions are needed when using this as the template for a new python project:

• Update readme.md for new project
• Update factbook.yaml for new project
• Update pyproject.toml with relevant name, description, and authors and remove unneeded dep groups
• Update python_template folder to match new project name
• Remove all example code files (leave __init__.py in place)
• Rename all references to python-template and python_template to new module/folder names
• Remove all example test files and all code from conftest.py (leave the docstring in place)
• Add placeholder tests so PR passes
• Get GH Admins to add mdsol robot key so PR passes
• Add Artifactory robot account info so PR passes

Contributing

See CONTRIBUTING.

Contact

See the factbook.