[Feature] Add more comprehensive error handling

.github/CONTRIBUTING.md

@@ -31,7 +31,7 @@ We use the following tools for linting and formatting:
 Style configurations of black and isort can be found in [pyproject.toml](../pyproject.toml).
 
 We use [pre-commit hook](https://pre-commit.com/) that checks and formats for `black`, `isort`, `trailing whitespaces`,
-fixes `end-of-files`, sorts `requirments.txt` automatically on every commit.
+fixes `end-of-files` automatically on every commit.
 The config for a pre-commit hook is stored in [.pre-commit-config](../.pre-commit-config.yaml).
 
 After you clone the repository, you will need to install initialize pre-commit hook.
@@ -47,21 +47,22 @@ pre-commit install
 ```
 
 If you are facing an issue when installing markdown lint, you may install ruby for markdown lint by
-referring to [this repo](https://github.com/innerlee/setup) by following the usage and taking [`zzruby.sh`](https://github.com/innerlee/setup/blob/master/zzruby.sh)
+referring to [this repo](https://github.com/innerlee/setup)
+by following the usage and taking [`zzruby.sh`](https://github.com/innerlee/setup/blob/master/zzruby.sh)
 
- or by the following steps
+or by the following steps
 
- ```shell
+```shell
 # install rvm
 curl -L https://get.rvm.io | bash -s -- --autolibs=read-fail
 rvm autolibs disable
- # install ruby
+# install ruby
 rvm install 2.7.1
 ```
 
 After this on every commit check code linters and formatter will be enforced.
 
-> Before you create a PR, make sure that your code lints and is formatted by yapf.
+> Before you create a PR, make sure that your code lints and is formatted by black.
 
 ### C++ and CUDA
 

README.md

@@ -6,11 +6,15 @@
 
 <br/>
 
+<div align="center">
+
 [![Documentation](https://readthedocs.org/projects/xrfeitoria/badge/?version=latest)](https://xrfeitoria.readthedocs.io/en/latest/?badge=latest)
 [![actions](https://github.com/openxrlab/xrfeitoria/workflows/lint/badge.svg)](https://github.com/openxrlab/xrfeitoria/actions)
 [![PyPI](https://img.shields.io/pypi/v/xrfeitoria)](https://pypi.org/project/xrfeitoria/)
 [![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
+</div>
+
 ## Introduction
 
 XRFeitoria is a rendering toolbox for generating synthetic data photorealistic with ground-truth annotations.
@@ -61,10 +65,14 @@ wget https://graphics.stanford.edu/~mdfisher/Data/Meshes/bunny.obj
 xf-render bunny.obj
 ```
 
+### Documentation
+
+The reference documentation is available on [readthedocs](https://xrfeitoria.readthedocs.io/en/latest/).
+
 ### Tutorials
 
 There are several [tutorials](/tutorials/).
-You can read them [here](https://openxrlab-share.oss-cn-hongkong.aliyuncs.com/xrfeitoria/docs/en/_build/html/src/Tutorials.html).
+You can read them [here](https://xrfeitoria.readthedocs.io/en/latest/src/Tutorials.html).
 
 
 ### Sample codes

docs/en/README.md

@@ -5,15 +5,15 @@
 ### Setup Python Environment
 
 ```bash
-pip install -r requirements/docs.txt
+pip install xrfeitoria[doc]
 ```
 
 ### Install Graphviz
 
-- Windows: Download and install from [link](https://graphviz.org/download/#windows),
-and add the `bin` folder to `PATH` environment variable.
+- Windows: [Download](https://graphviz.org/download/#windows) and install,
+and add the `bin` folder to `PATH` environment variable
 
-- Linux: Install with `sudo apt install graphviz`,
+- Linux: `sudo apt install graphviz`
 
 ### Install pandoc
 

docs/en/index.rst

@@ -62,7 +62,7 @@ Requirements
 
     src/cli.md
     src/Tutorials.rst
-    src/Samples.rst
+    Samples <https://github.com/openxrlab/xrfeitoria/tree/main/samples>
 
 --------
 

docs/en/src/Tutorials.rst

@@ -19,4 +19,6 @@ The following tutorials cover the basic operations needed to render with ``XRFei
 Extra Samples
 --------------
 
-For more advanced examples, see the :ref:`samples` section.
+.. _samples: https://github.com/openxrlab/xrfeitoria/tree/main/samples/
+
+For more advanced examples, see the `samples`_ section.

pyproject.toml

@@ -21,6 +21,8 @@ requires-python = ">=3.8, <3.11"
 license = { text = 'Apache License 2.0' }
 classifiers = [
     "Operating System :: Microsoft :: Windows",
+    "Operating System :: Unix",
+    "Operating System :: MacOS :: MacOS",
     "Operating System :: POSIX :: Linux",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
@@ -32,6 +34,7 @@ dependencies = [
     "fake-bpy-module-latest",
     "numpy>=1,<2",
     "loguru<1",
+    "packaging>=23,<24",
     "pydantic>=2,<3",
     "psutil>=5,<6",
     "rich>=13,<14",
@@ -56,15 +59,12 @@ doc = [
     "sphinx-rtd-theme==1.3.0",
     "sphinx-tabs==3.4.1",
     "enum-tools[sphinx]",
-
-    # https://graphviz.org/download/#windows
-    # sudo apt install pandoc
-    # sudo apt install graphviz
 ]
 
 [project.urls]
 "Homepage" = "https://github.com/openxrlab/xrfeitoria"
 "Bug Tracker" = "https://github.com/openxrlab/xrfeitoria/issues"
+"Documentation" = "https://xrfeitoria.readthedocs.io/en/latest/"
 
 [project.scripts]
 xf-render = "xrfeitoria.cmd.render:app"

samples/README.md

@@ -1,7 +1,15 @@
 # Samples
 
-## Configure
-First, configure the **executable path** of blender or unreal by execute:
+## Clone
+
+```bash
+git clone https://github.com/openxrlab/xrfeitoria.git
+cd xrfeitoria
+```
+
+## Setup the environment
+
+After [installation](../README.md#Installation), configure the **executable path** of blender or unreal by executing:
 
 ```bash
 python -m samples.setup

src/XRFeitoriaBpy/__init__.py

@@ -4,7 +4,7 @@
 bl_info = {
     'name': 'XRFeitoriaBpy',
     'author': 'OpenXRLab',
-    'version': (0, 1, 0),
+    'version': (0, 5, 0),
     'blender': (3, 3, 0),
     'category': 'Tools',
 }

src/XRFeitoriaUnreal/XRFeitoriaUnreal.uplugin

@@ -1,13 +1,13 @@
 {
 	"FileVersion": 3,
 	"Version": 1,
-	"VersionName": "1.0",
+	"VersionName": "0.5.0",
 	"FriendlyName": "XRFeitoriaUnreal",
-	"Description": "",
-	"Category": "Other",
-	"CreatedBy": "",
+	"Description": "OpenXRLab Synthetic Data Rendering Toolbox",
+	"Category": "Scripting",
+	"CreatedBy": "OpenXRLab",
 	"CreatedByURL": "",
-	"DocsURL": "",
+	"DocsURL": "https://xrfeitoria.readthedocs.io/en/latest/",
 	"MarketplaceURL": "",
 	"SupportURL": "",
 	"CanContainContent": true,

tutorials/01_get_started.ipynb

@@ -17,9 +17,7 @@
    "source": [
     "## Import XRFeitoria\n",
     "\n",
-    "After [Installing][1], import ``XRfeitoria`` by\n",
-    "\n",
-    "[1]: http://xrfeitoria.readthedocs.io/en/latest/installation.html"
+    "After [Installing](../../index.rst#installation), import ``XRfeitoria`` by"
    ]
   },
   {
@@ -152,11 +150,6 @@
    "source": [
     "Ref to [api docs](../../apis/xrfeitoria.rst), you can always use ``with`` statement to ensure the engine is closed when the codes are finished."
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": []
   }
  ],
  "metadata": {

xrfeitoria/data_structure/constants.py

@@ -10,27 +10,28 @@
 PathLike = Union[str, Path]
 actor_info_type = TypedDict('actor_info', {'actor_name': str, 'mask_color': Tuple[int, int, int]})
 
+##### Package Constants #####
+
+package_name = 'XRFeitoria'
+plugin_name_blender = 'XRFeitoriaBpy'
+plugin_name_unreal = 'XRFeitoriaUnreal'
+xf_obj_name = '[XF]{obj_type}-{obj_idx:03d}'
+
 ##### Path Constants #####
 
-tmp_dir = Path.home() / '.tmp' / 'XRFeitoria'
+tmp_dir = Path.home() / '.tmp' / package_name
 tmp_dir.mkdir(parents=True, exist_ok=True)
 actor_infos = 'actor_infos'
 cam_param_dir = 'camera_params'
 
-config_dir = Path.home() / '.config' / 'XRFeitoria'
+config_dir = Path.home() / '.config' / package_name
 config_dir.mkdir(parents=True, exist_ok=True)
 config_path = config_dir / 'config.ini'
 ConfigDict = TypedDict('ConfigDict', {'blender_exec': Optional[Path], 'unreal_exec': Optional[Path]})
 
-##### Package Constants #####
-
-plugin_name_blender = 'XRFeitoriaBpy'
-plugin_name_unreal = 'XRFeitoriaUnreal'
-xf_obj_name = '[XF]{obj_type}-{obj_idx:03d}'
-
 ##### Blender Constants #####
 
-default_level_blender = 'XRFeitoria'
+default_level_blender = package_name
 
 ##### Unreal Constants #####
 

xrfeitoria/utils/downloader.py

@@ -24,6 +24,7 @@ def download(url: str, dst_dir: Path, verbose: bool = True) -> Path:
     Returns:
         Path: The path to the downloaded file.
     """
+    dst_dir = Path(dst_dir).resolve()
     dst_dir.mkdir(parents=True, exist_ok=True)
     filename = url.split('/')[-1]
     dst_path = Path(dst_dir).resolve() / filename
@@ -46,32 +47,27 @@ def download(url: str, dst_dir: Path, verbose: bool = True) -> Path:
         )
         with progress:
             task_id = progress.add_task('download', filename=filename, start=False)
-            logger.info(f'Requesting {url}')
+            logger.info(f'Requesting {url} to "{dst_path.as_posix()}"')
             response = urlopen(url)
             # This will break if the response doesn't contain content length
             progress.update(task_id, total=int(response.info()['Content-length']))
             with open(dst_path, 'wb') as dst_file:
                 progress.start_task(task_id)
-                logger.info(f'Downloading to "{dst_path.as_posix()}"')
+                # logger.info(f'Downloading to "{dst_path.as_posix()}"')
                 for data in iter(partial(response.read, 32768), b''):
                     dst_file.write(data)
                     progress.update(task_id, advance=len(data))
             logger.info(f'Downloaded "{dst_path.as_posix()}"')
 
     except KeyboardInterrupt:
-        logger.info('[red]Cancelling download...')
-        logger.info('[red]Deleting incomplete download...')
+        logger.info('[red]Cancelling download...[/red]')
+        logger.info('[red]Deleting incomplete download...[/red]')
         dst_path.unlink(missing_ok=True)
         exit(1)
 
     return dst_path
 
 
 if __name__ == '__main__':
-    # Try with https://releases.ubuntu.com/20.04/ubuntu-20.04.6-desktop-amd64.iso
-    import sys
-
-    if sys.argv[1:]:
-        download(sys.argv[-1], './')
-    else:
-        print('Usage:\n\tpython downloader.py URL1 URL2 URL3 (etc)')
+    url = 'https://releases.ubuntu.com/20.04/ubuntu-20.04.6-desktop-amd64.iso'
+    download(url, './')

xrfeitoria/utils/plugin_infos.json

@@ -0,0 +1,8 @@
+{
+    "0.5.0":
+    {
+        "XRFeitoria": "0.5.0",
+        "XRFeitoriaBpy": "0.5.0",
+        "XRFeitoriaUnreal": "0.5.0"
+    }
+}