Merge pull request #35 from robotology/feature/setup.cfg

Add `setup.cfg`, enforce code style, multiplatform support

Author: diegoferigo

.github/workflows/style.yml

@@ -0,0 +1,50 @@
+name: Code Style
+
+on:
+  push:
+    branches: ["**"]
+    tags-ignore: ["**"]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+
+  black:
+
+    name: black
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: "🔀 Checkout repository"
+        uses: actions/checkout@v2
+
+      - name: '🐍 Initialize Python'
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: "📝 Black Code Formatter"
+        uses: psf/black@stable
+        with:
+          options: --check --diff --color
+
+  isort:
+
+    name: isort
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: "🔀 Checkout repository"
+        uses: actions/checkout@v2
+
+      - name: '🐍 Initialize Python'
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: "📝 isort"
+        uses: isort/isort-action@master
+        with:
+          configuration: --check --diff --color

pyproject.toml

@@ -1,3 +1,20 @@
+# Copyright (C) 2021 Istituto Italiano di Tecnologia (IIT). All rights reserved.
+# This software may be modified and distributed under the terms of the
+# GNU Lesser General Public License v2.1 or any later version.
 [build-system]
-requires = ["setuptools>=40.8.0", "wheel", "setuptools_scm"]
+requires = [
+    "wheel",
+    "setuptools>=45",
+    "setuptools_scm[toml]>=6.0",
+]
 build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+local_scheme = "dirty-tag"
+
+[tool.black]
+line-length = 88
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3

setup.cfg

@@ -0,0 +1,72 @@
+# Copyright (C) 2021 Istituto Italiano di Tecnologia (IIT). All rights reserved.
+# This software may be modified and distributed under the terms of the
+# GNU Lesser General Public License v2.1 or any later version.
+
+[metadata]
+name = gym_ignition_models
+description = Collection of robot models for the Ignition Gazebo simulator.
+long_description = file: README.md
+long_description_content_type = text/markdown
+author = Diego Ferigo
+author_email = dgferigo@gmail.com
+license = LGPL
+license_file = LICENSE
+platforms = any
+url = https://github.com/robotology/gym-ignition-models
+
+project_urls =
+    Changelog = https://github.com/robotology/gym-ignition-models/releases
+    Tracker = https://github.com/robotology/gym-ignition-models/issues
+    Source = https://github.com/robotology/gym-ignition-models
+
+keywords =
+    model
+    description
+    urdf
+    sdf
+    gazebo
+    ignition
+    robot
+    robotics
+    panda
+    icub
+    simulation
+
+classifiers =
+    Development Status :: 5 - Production/Stable
+    Operating System :: POSIX :: Linux
+    Topic :: Games/Entertainment :: Simulation
+    Topic :: Scientific/Engineering :: Physics
+    Framework :: Robot Framework
+    Intended Audience :: Developers
+    Intended Audience :: Science/Research
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3 :: Only
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
+    Programming Language :: Python :: Implementation :: CPython
+    License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
+
+[options]
+zip_safe = False
+packages = find:
+package_dir =
+    =src
+python_requires = >=3.7
+
+[options.packages.find]
+where = src
+
+[options.package_data]
+gym_ignition_models =
+    meshes/*.*
+    meshes/**/*.*
+    meshes/**/**/*.*
+    */meshes/*.*
+    */meshes/**/*.*
+    */meshes/**/**/*.*
+    */*.sdf
+    */*.urdf
+    */model.config

setup.py

@@ -4,16 +4,16 @@
 
 import os
 import shutil
-import platform
+
+import setuptools
 from setuptools.command.build_ext import build_ext
-from setuptools import setup, find_packages, Extension
 
 
-class CopyMeshes(Extension):
+class CopyMeshes(setuptools.Extension):
     extension_name = "CopyMeshes"
 
     def __init__(self):
-        Extension.__init__(self, name=self.extension_name, sources=[])
+        setuptools.Extension.__init__(self, name=self.extension_name, sources=[])
 
 
 class BuildExtension(build_ext):
@@ -38,9 +38,6 @@ def run(self) -> None:
         if len(self.extensions) != 1 or not isinstance(self.extensions[0], CopyMeshes):
             raise RuntimeError("This class can only build one CopyMeshes object")
 
-        if platform.system() != "Linux":
-            raise RuntimeError("Only Linux is currently supported")
-
         for ext in self.extensions:
             self.build_extension(ext)
 
@@ -60,7 +57,9 @@ def build_extension(self, ext) -> None:
 
         # Check that the directory exists
         if not os.path.isdir(pkg_dir):
-            raise RuntimeError(f"The build package directory '{pkg_dir}' does not exist")
+            raise RuntimeError(
+                f"The build package directory '{pkg_dir}' does not exist"
+            )
 
         # Copy the folders
         for dest, orig in self.FROM_DEST_TO_ORIG.items():
@@ -84,49 +83,7 @@ def build_extension(self, ext) -> None:
 with open(os.path.join(this_directory, "README.md"), encoding="utf-8") as f:
     long_description = f.read()
 
-setup(
-    name="gym-ignition-models",
-    author="Diego Ferigo",
-    author_email="diego.ferigo@iit.it",
-    description="Collection of robot models for the Ignition Gazebo simulator",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    url="https://github.com/robotology/gym-ignition-models",
-    project_urls={
-        "Bug Tracker": "https://github.com/robotology/gym-ignition-models/issues",
-        "Source Code": "https://github.com/robotology/gym-ignition-models",
-    },
-    keywords=["model", "description", "urdf", "sdf", "gazebo", "ignition", "robot",
-               "robotics", "panda", "icub", "simulation"],
-    license="LGPL",
-    platforms="any",
-    classifiers=[
-        "Development Status :: 5 - Production/Stable",
-        "Operating System :: POSIX :: Linux",
-        "Topic :: Games/Entertainment :: Simulation",
-        "Topic :: Scientific/Engineering :: Artificial Intelligence",
-        "Framework :: Robot Framework",
-        "Intended Audience :: Developers",
-        "Intended Audience :: Science/Research",
-        "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)",
-    ],
-    use_scm_version=dict(local_scheme="dirty-tag"),
-    setup_requires=["setuptools_scm"],
-    python_requires=">=3.6",
-    packages=find_packages(),
-    package_data={"gym_ignition_models": [
-        "meshes/*.*",
-        "meshes/**/*.*",
-        "meshes/**/**/*.*",
-        "*/meshes/*.*",
-        "*/meshes/**/*.*",
-        "*/meshes/**/**/*.*",
-        "*/*.sdf",
-        "*/*.urdf",
-        "*/model.config",
-    ]},
+setuptools.setup(
     ext_modules=[CopyMeshes()],
     cmdclass=dict(build_ext=BuildExtension),
-    zip_safe=False,
 )

gym_ignition_models/__init__.py src/gym_ignition_models/__init__.pygym_ignition_models/__init__.py renamed to src/gym_ignition_models/__init__.py

@@ -2,8 +2,8 @@
 # This software may be modified and distributed under the terms of the
 # GNU Lesser General Public License v2.1 or any later version.
 
-import os
 import enum
+import os
 import tempfile
 from pathlib import Path
 from typing import IO, List, Union
@@ -17,7 +17,7 @@ def get_models_path() -> str:
         A string containing the path of the models.
     """
     models_dir = os.path.join(os.path.dirname(__file__))
-    return models_dir + '/'
+    return models_dir + "/"
 
 
 def get_robot_names() -> List[str]:
@@ -114,9 +114,9 @@ def setup_environment() -> None:
             raise NotADirectoryError(f"Failed to find path '{model_path}'")
 
         if "IGN_GAZEBO_RESOURCE_PATH" in os.environ:
-            os.environ["IGN_GAZEBO_RESOURCE_PATH"] += f':{model_path}'
+            os.environ["IGN_GAZEBO_RESOURCE_PATH"] += f":{model_path}"
         else:
-            os.environ["IGN_GAZEBO_RESOURCE_PATH"] = f'{model_path}'
+            os.environ["IGN_GAZEBO_RESOURCE_PATH"] = f"{model_path}"
 
 
 class ResourceType(enum.Enum):
@@ -130,9 +130,9 @@ class ResourceType(enum.Enum):
     URDF_STRING = enum.auto()
 
 
-def get_model_resource(robot_name: str,
-                       resource_type: ResourceType = ResourceType.URDF_PATH) \
-        -> Union[str, IO]:
+def get_model_resource(
+    robot_name: str, resource_type: ResourceType = ResourceType.URDF_PATH
+) -> Union[str, IO]:
     """
     Return the resource of the selected robot.
 
@@ -167,38 +167,41 @@ def get_model_resource(robot_name: str,
             with open(file=stored_model, mode="r+") as f:
                 return f.read()
 
-        if resource_type in {ResourceType.SDF_FILE,
-                             ResourceType.SDF_PATH,
-                             ResourceType.SDF_STRING}:
+        if resource_type in {
+            ResourceType.SDF_FILE,
+            ResourceType.SDF_PATH,
+            ResourceType.SDF_STRING,
+        }:
             try:
                 from scenario import gazebo as scenario_gazebo
             except ImportError:
                 msg = "URDF to SDF conversion requires the 'scenario' package"
                 raise RuntimeError(msg)
 
         if resource_type is ResourceType.SDF_FILE:
-            file_name = Path(stored_model).with_suffix('').name
-            sdf_file = tempfile.NamedTemporaryFile(mode="w+",
-                                                   prefix=file_name,
-                                                   suffix=".sdf")
-            sdf_string = get_model_resource(robot_name=robot_name,
-                                            resource_type=ResourceType.SDF_STRING)
+            file_name = Path(stored_model).with_suffix("").name
+            sdf_file = tempfile.NamedTemporaryFile(
+                mode="w+", prefix=file_name, suffix=".sdf"
+            )
+            sdf_string = get_model_resource(
+                robot_name=robot_name, resource_type=ResourceType.SDF_STRING
+            )
             sdf_file.write(sdf_string)
             return sdf_file
 
         if resource_type is ResourceType.SDF_PATH:
-            file_name = Path(stored_model).with_suffix('').name
-            fd, sdf_path = tempfile.mkstemp(prefix=file_name,
-                                            suffix=".sdf",
-                                            text=True)
-            sdf_string = get_model_resource(robot_name=robot_name,
-                                            resource_type=ResourceType.SDF_STRING)
+            file_name = Path(stored_model).with_suffix("").name
+            fd, sdf_path = tempfile.mkstemp(prefix=file_name, suffix=".sdf", text=True)
+            sdf_string = get_model_resource(
+                robot_name=robot_name, resource_type=ResourceType.SDF_STRING
+            )
             with open(sdf_path, "w") as f:
                 f.write(sdf_string)
             return sdf_path
 
         if resource_type is ResourceType.SDF_STRING:
             from scenario import gazebo as scenario_gazebo
+
             return scenario_gazebo.urdffile_to_sdfstring(urdf_file=stored_model)
 
         raise ValueError(resource_type)
@@ -208,9 +211,11 @@ def get_model_resource(robot_name: str,
         if resource_type is ResourceType.SDF_PATH:
             return stored_model
 
-        if resource_type in {ResourceType.URDF_FILE,
-                             ResourceType.URDF_PATH,
-                             ResourceType.URDF_STRING}:
+        if resource_type in {
+            ResourceType.URDF_FILE,
+            ResourceType.URDF_PATH,
+            ResourceType.URDF_STRING,
+        }:
             raise ValueError("SDF to URDF conversion is not supported")
 
         if resource_type is ResourceType.SDF_STRING: