template-python-project

Overview

The following repository demonstrates an example Python project -- both as a library and callable.

Additionally, there includes documentation, examples, and scripts relating to:

• Python packaging best practices
• Private package registries
• Private CA certificates and considerations
• Virtual Environments
• Local development opportunities and implications

CI-CD

The project includes a .gitlab-ci.yml file that demonstrates automated-related builds, testing, and other useful "workflows" or "pipeline" logic. While not compatible with GitHub, configuration is relatively the same and straight forward.

Contributing and Local Development

Please see CONTRIBUTING.md for additional details and useful development instruction(s).

Troubleshooting & Additional Reference(s)

Also see the CONTRIBUTING.md file for various troubleshooting information and external documentation reference(s).