NASA-AMMOS/slim#46: Rename to slim_sample_project and reset release v…

…ariables. ...
NASA-AMMOS · Dec 14, 2022 · 63ef9f6 · 63ef9f6
1 parent 8d39fbf
commit 63ef9f6
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 11 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -8,5 +8,5 @@ requires = [
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]
-write_to = "slim_starterkit/version.py"
+write_to = "slim_sample_project/version.py"
 write_to_template = "__version__ = '{version}'\n"
diff --git a/setup.cfg b/setup.cfg
@@ -1,5 +1,5 @@
 [metadata]
-name = slim_starterkit
+name = slim_sample_project
 url = https://github.com/NASA-AMMOS/slim-starterkit-python
 download_url = https://github.com/NASA-AMMOS/slim-starterkit-python/releases/latest
 project_urls =
@@ -28,7 +28,7 @@ classifiers =
 license = Apache-2.0
 license_files =
     LICENSE
-description = SLIM Starterkit Python: Python3 application development starterkit from NASA JPL's Software Lifecycle Improvement & Modernization (SLIM) project
+description = SLIM Starterkit Python: Python3 application development sample project from NASA JPL's Software Lifecycle Improvement & Modernization (SLIM) project
 long_description = file: README.md
 long_description_content_type = text/markdown; charset=UTF-8
 keywords = nasa, jpl, SLIM, development, developer, python, application, starter kit, template
@@ -37,14 +37,12 @@ keywords = nasa, jpl, SLIM, development, developer, python, application, starter
 zip_safe = False
 python_requires = >=3.7
 include_package_data = True
-packages =
-    slim_starterkit
-    slim_starterkit.api
+packages = find:
 install_requires = file: requirements.txt
 
 [options.entry_points]
 console_scripts =
-    slim-starterkit-python = slim_starterkit.hello_world:main
+    slim-sample-project = slim_sample_project.hello_world:main
 
 [options.packages.find]
 exclude =

diff --git a/slim_starterkit/__init__.py → slim_sample_project/__init__.py b/slim_starterkit/__init__.py → slim_sample_project/__init__.py
diff --git a/slim_starterkit/api/__init__.py → slim_sample_project/api/__init__.py b/slim_starterkit/api/__init__.py → slim_sample_project/api/__init__.py
diff --git a/slim_starterkit/api/text_processor.py → slim_sample_project/api/text_processor.py b/slim_starterkit/api/text_processor.py → slim_sample_project/api/text_processor.py
@@ -12,8 +12,11 @@ class TextWriter:
     def __init__(self, color=None):
         """
         Initialization method for TextWriter class.
-        :param color: A color to display provided text characters.
+        :param color:
         :type color: AnsiFore
+        @param color:  A Colorama ANSI color Enum value used
+            to display provided text characters.
+        @type color: Fore
         """
         if not color:
             self.color = [Fore.CYAN, Fore.BLACK, Fore.YELLOW][randint(0, 2)]

diff --git a/slim_starterkit/hello_world.py → slim_sample_project/hello_world.py b/slim_starterkit/hello_world.py → slim_sample_project/hello_world.py
@@ -4,12 +4,12 @@
 
 from api.text_processor import TextWriter
 import importlib_metadata as metadata
-import slim_starterkit.version as v
+import slim_sample_project.version as v
 
 try:
     version = metadata.version(__name__)
 except metadata.PackageNotFoundError:
-    # package is not installed, try reading from slim_starterkit script
+    # package is not installed, try reading from slim_sample_project script
     version = v.__version__ if v.__version__ else "unset"
     pass
 

diff --git a/slim_sample_project/version.py b/slim_sample_project/version.py
@@ -0,0 +1 @@
+__version__ = '0.1.0'
diff --git a/slim_starterkit/version.py b/slim_starterkit/version.py