Merge pull request #10 from cisagov/improvement/data

Improvement/data

setup.py

@@ -64,9 +64,10 @@ def package_vars(version_file):
     keywords="skeleton",
     packages=find_packages(where="src"),
     package_dir={"": "src"},
+    package_data={"example": ["data/*.txt"]},
     py_modules=[splitext(basename(path))[0] for path in glob("src/*.py")],
     include_package_data=True,
-    install_requires=["docopt"],
+    install_requires=["docopt", "setuptools"],
     extras_require={"test": ["pre-commit", "pytest", "pytest-cov", "coveralls"]},
     # Conveniently allows one to run the CLI tool as `example`
     entry_points={"console_scripts": ["example = example.example:main"]},

src/example/data/secret.txt

@@ -0,0 +1 @@
+Three may keep a secret, if two of them are dead.

src/example/example.py

@@ -14,12 +14,16 @@
 """
 
 import logging
+import os
 import sys
 
 import docopt
+import pkg_resources
 
 from ._version import __version__
 
+DEFAULT_ECHO_MESSAGE = "Hello World from the example default!"
+
 
 def example_div(x, y):
     """Print some logging messages."""
@@ -47,7 +51,19 @@ def main():
         )
         return 1
 
-    print(example_div(8, 2))
+    print(f"8 / 2 == {example_div(8, 2)}")
+
+    # Access some data from an environment variable
+    message = os.getenv("ECHO_MESSAGE", DEFAULT_ECHO_MESSAGE)
+    print(f'ECHO_MESSAGE="{message}"')
+
+    # Access some data from our package data (see the setup.py)
+    secret_message = (
+        pkg_resources.resource_string("example", "data/secret.txt")
+        .decode("utf-8")
+        .strip()
+    )
+    print(f'Secret="{secret_message}"')
 
     # Stop logging and clean up
     logging.shutdown()