Initial package

Author: cottsay

README.rst

@@ -1,11 +1,4 @@
-template-package
-================
+colcon-ansi-colors-example
+==========================
 
-An extension for `colcon-core <https://github.com/colcon/colcon-core>`_ to act as a template for new extensions.
-
-When using this template, be sure to replace all instances of the word "template" in the repository::
-
-   $ find * -type f | xargs sed -i 's/template-package/colcon-package-name/g'
-   $ find * -type f | xargs sed -i 's/template_package/colcon_package_name/g'
-   $ mv template_package colcon_package_name
-   $ grep -iR template *
+An extension for `colcon-core <https://github.com/colcon/colcon-core>`_ to colorize output using ANSI sequences.

template_package/__init__.py renamed to colcon_ansi_colors_example/__init__.py

@@ -1,12 +1,12 @@
 [metadata]
-name = template-package
-version = attr: template_package.__version__
+name = colcon-ansi-colors-example
+version = attr: colcon_ansi_colors_example.__version__
 url = https://colcon.readthedocs.io
 project_urls =
-  Changelog = https://github.com/colcon/template-package/milestones?direction=desc&sort=due_date&state=closed
-  GitHub = https://github.com/colcon/template-package/
-author = Colcon Template Author
-author_email = [email protected]
+  Changelog = https://github.com/colcon/colcon-ansi-colors-example/milestones?direction=desc&sort=due_date&state=closed
+  GitHub = https://github.com/colcon/colcon-ansi-colors-example/
+author = Scott K Logan
+author_email = [email protected]
 classifiers =
   Development Status :: 3 - Alpha
   Environment :: Plugins
@@ -17,14 +17,14 @@ classifiers =
   Programming Language :: Python
   Topic :: Software Development :: Build Tools
 license = Apache License, Version 2.0
-description = Extension for colcon to serve as a template for new extensions.
+description = Extension for colcon to colorize output using ANSI.
 long_description = file: README.rst
 keywords = colcon
 
 [options]
 python_requires = >=3.6
 install_requires =
-  colcon-core
+  colcon-core >= 0.19.0
 packages = find:
 zip_safe = true
 
@@ -46,7 +46,7 @@ test =
   scspell3k>=2.2
 
 [tool:pytest]
-junit_suite_name = template-package
+junit_suite_name = colcon-ansi-colors-example
 markers =
   flake8
   linter
@@ -57,4 +57,4 @@ markers =
 import-order-style = google
 
 [coverage:run]
-source = template_package
+source = colcon_ansi_colors_example

setup.cfg

@@ -1,4 +1,4 @@
-[template-package]
+[colcon-ansi-colors-example]
 No-Python2:
 Depends3: python3-colcon-core
 Suite: focal jammy noble bookworm trixie

stdeb.cfg

@@ -1,3 +1,4 @@
+ansi
 apache
 colcon
 iterdir

test/spell_check.words

@@ -33,7 +33,7 @@ def test_flake8():
     sys.stdout = sys.stderr
     # implicitly calls report_errors()
     report = style_guide.check_files([
-        str(Path(__file__).parents[1] / 'template_package'),
+        str(Path(__file__).parents[1] / 'colcon_ansi_colors_example'),
     ])
     report_tests = style_guide_tests.check_files([
         str(Path(__file__).parents[1] / 'test'),

test/test_flake8.py

@@ -10,7 +10,6 @@
 
 @pytest.fixture(scope='module')
 def known_words():
-    global spell_check_words_path
     return spell_check_words_path.read_text().splitlines()
 
 
@@ -22,7 +21,7 @@ def test_spell_check(known_words):
 
     source_filenames = [Path(__file__).parents[1] / 'setup.py'] + \
         list(
-            (Path(__file__).parents[1] / 'template_package')
+            (Path(__file__).parents[1] / 'colcon_ansi_colors_example')
             .glob('**/*.py')) + \
         list((Path(__file__).parents[1] / 'test').glob('**/*.py'))