installable command line interface

Author: esdandreu

README.md

@@ -1,8 +1,12 @@
-# Visual and Acoustic recorder
+# python-recorder
 
 Visual and Acoustic Odometry recorder using python. Devices: RealSense D435i
 camera, RODE VideoMicNTG and smartLav+ microphones
 
+Framework
+
+TODO ros
+
 # Setup
 
 Clone this repository to your local machine. Detailed instructions about

pyproject.toml

@@ -0,0 +1,34 @@
+[tool.poetry]
+name = "python-recorder"
+version = "0.0.1"
+description = ""
+authors = ["Andreu Gimenez <esdandreu@gmail.com>"]
+readme = "README.md"
+license = "MIT"
+packages = [{include = "recorder"}]
+
+[tool.poetry.scripts]
+recorder = "recorder.__main__:app"
+
+[tool.poetry.dependencies]
+python = "^3.7"
+typer = {extras = ["all"], version = "^0.4.0"}
+PyInquirer = "^1.0.3"
+PyYAML = "^5.1"
+numpy = "^1.22.2"
+sounddevice = {version = "^0.4.4", optional = true}
+pyrealsense2 = {version = "^2.50.0", optional = true}
+Flask = {version = "^2.1.1", optional = true}
+
+[tool.poetry.dev-dependencies]
+pytest = "^7.1.1"
+
+[tool.poetry.extras]
+realsense = ["pyrealsense2"]
+microphone = ["sounddevice"]
+localhost = ["Flask"]
+all = ["pyrealsense2", "sounddevice", "Flask"]
+
+[build-system]
+requires = ["poetry>=0.12"]
+build-backend = "poetry.masonry.api"

vao-recorder.py recorder/__main__.pyvao-recorder.py renamed to recorder/__main__.py

@@ -185,9 +185,13 @@ def test(
         output_folder = recorder(seconds=5)
 
 
-if __name__ == '__main__':
+def main():
     # Launch the command line application
     try:
-        app()
+        app(prog_name='recorder')
     except RuntimeError as e:
-        typer.secho(str(e), fg='red')
+        typer.secho(str(e), fg='red')
+
+
+if __name__ == '__main__':
+    main()

recorder/config.py

@@ -3,11 +3,10 @@
 
 from typing import List
 from pathlib import Path
-from datetime import datetime
 
-DEFAULT_CONFIG_PATH = Path.cwd() / 'vao-recorder.yaml'
+DEFAULT_CONFIG_PATH = Path.cwd() / 'python-recorder.yaml'
 
-DEFAULT_OUTPUT_FOLDER = Path.cwd() / 'output' 
+DEFAULT_OUTPUT_FOLDER = Path.cwd() / 'recordings' 
 
 
 class Config(dict):

recorder/device/__init__.py

@@ -1,5 +1,15 @@
 from .device import Device
-from .microphone import Microphone
-from .realsense import RealSense
+try:
+    from .microphone import Microphone
+except ImportError as e:
+    class Microphone:
+        def __init__(self, *args, **kwargs) -> None:
+            raise e
+try:
+    from .realsense import RealSense
+except ImportError as e:
+    class RealSense:
+        def __init__(self, *args, **kwargs) -> None:
+            raise e
 
 DEVICE_CLASSES = {repr(cls): cls for cls in Device.__subclasses__()}

recorder/device/device.py

@@ -2,7 +2,6 @@
 
 from typing import Dict
 from pathlib import Path
-from warnings import warn
 from datetime import datetime
 from abc import ABC, ABCMeta, abstractmethod