template-python

If you are beginning your journey with Senzing, please start with Senzing Quick Start guides.

You are in the Senzing Garage where projects are "tinkered" on. Although this GitHub repository may help you understand an approach to using Senzing, it's not considered to be "production ready" and is not considered to be part of the Senzing product. Heck, it may not even be appropriate for your application of Senzing!

⚠️ WARNING: template-python is still in development ⚠️ _

At the moment, this is "work-in-progress" with Semantic Versions of 0.n.x. Although it can be reviewed and commented on, the recommendation is not to use it yet.

Synopsis

This section should give 1-2 sentences on what the artifacts in this repository do.

Overview

This section should be replaced with real "Overview" content after initial repository creation.

This repository (template-python) contains exemplar python scripts that can be used to start a new python project.

The template-python.py python script is a boilerplate which has the following features:

1. Conforms to PEP-0008 python programming style guide.
   1. With exception of some lines being too long.
2. "command subcommand" command line.
3. A structured command line parser and "-help"
4. Configuration via:
   1. Command line options
   2. Environment variables
   3. Configuration file
   4. Default
5. Messages dictionary
6. Logging and Log Level support.
7. Entry / Exit log messages.
8. Docker support.

Use

Configuration

Configuration values specified by environment variable or command line parameter.

• SENZING_DATABASE_URL
• SENZING_DEBUG

References

1. Development
2. Errors
3. Examples
4. Related artifacts:
   1. DockerHub