Migrate from 'scripts' to 'entry_points.console_scripts'

Modern Python projects use 'entry_points.console_scripts' over the installation of pre-made 'scripts'. Importantly, this makes the executables usable on Windows.
ros-infrastructure · Jun 28, 2024 · 26abe55 · 26abe55
1 parent 48c6be5
commit 26abe55
Show file tree

Hide file tree

Showing 10 changed files with 11 additions and 10 deletions.
diff --git a/setup.py b/setup.py
@@ -14,16 +14,17 @@
     'python_requires': '>=3.6',
     'packages': find_packages('src'),
     'package_dir': {'': 'src'},
-    'scripts': [
-        # 'scripts/rosdistro',
-        'scripts/rosdistro_build_cache',
-        'scripts/rosdistro_freeze_source',
-        # 'scripts/rosdistro_convert',
-        # 'scripts/rosdistro_generate_cache',
-        'scripts/rosdistro_migrate_to_rep_141',
-        'scripts/rosdistro_migrate_to_rep_143',
-        'scripts/rosdistro_reformat'
-    ],
+    'entry_points': {
+        'console_scripts': [
+            # 'rosdistro = rosdistro.cli.rosdistro:main',
+            'rosdistro_build_cache = rosdistro.cli.rosdistro_build_cache:main',
+            'rosdistro_freeze_source = rosdistro.cli.rosdistro_freeze_source:main',
+            # 'rosdistro_convert = rosdistro.cli.rosdistro_convert:main',
+            # 'rosdistro_generate_cache = rosdistro.cli.rosdistro_generate_cache:main',
+            'rosdistro_migrate_to_rep_141 = rosdistro.cli.rosdistro_migrate_to_rep_141:main',
+            'rosdistro_migrate_to_rep_143 = rosdistro.cli.rosdistro_migrate_to_rep_143:main',
+            'rosdistro_reformat = rosdistro.cli.rosdistro_reformat:main'
+        ]},
     'extras_require': {
         'test': [
             'pytest',

diff --git a/src/rosdistro/cli/__init__.py b/src/rosdistro/cli/__init__.py
diff --git a/scripts/rosdistro → src/rosdistro/cli/rosdistro.py b/scripts/rosdistro → src/rosdistro/cli/rosdistro.py
diff --git a/scripts/rosdistro_build_cache → src/rosdistro/cli/rosdistro_build_cache.py b/scripts/rosdistro_build_cache → src/rosdistro/cli/rosdistro_build_cache.py
diff --git a/scripts/rosdistro_convert → src/rosdistro/cli/rosdistro_convert.py b/scripts/rosdistro_convert → src/rosdistro/cli/rosdistro_convert.py
diff --git a/scripts/rosdistro_freeze_source → src/rosdistro/cli/rosdistro_freeze_source.py b/scripts/rosdistro_freeze_source → src/rosdistro/cli/rosdistro_freeze_source.py
diff --git a/scripts/rosdistro_generate_cache → ...rosdistro/cli/rosdistro_generate_cache.py b/scripts/rosdistro_generate_cache → ...rosdistro/cli/rosdistro_generate_cache.py
diff --git a/scripts/rosdistro_migrate_to_rep_141 → ...istro/cli/rosdistro_migrate_to_rep_141.py b/scripts/rosdistro_migrate_to_rep_141 → ...istro/cli/rosdistro_migrate_to_rep_141.py
diff --git a/scripts/rosdistro_migrate_to_rep_143 → ...istro/cli/rosdistro_migrate_to_rep_143.py b/scripts/rosdistro_migrate_to_rep_143 → ...istro/cli/rosdistro_migrate_to_rep_143.py
diff --git a/scripts/rosdistro_reformat → src/rosdistro/cli/rosdistro_reformat.py b/scripts/rosdistro_reformat → src/rosdistro/cli/rosdistro_reformat.py