Voice-Activated Natural Language UI
Platform Supported
Language Stats
Code Stats
Deployments
Activity
Development and Maintenance
Reach Out
Kick off
💡 Using a dedicated virtual environment and an IDE like PyCharm is highly recommended.
Install
python -m pip install jarvis-ironman
Initiate
import jarvis
if __name__ == '__main__':
jarvis.start()
Prerequisites
-
MacOS
Tested on macOS High Sierra, Mojave, Catalina, Big Sur, Monterey and Ventura-
System Preferences
→Security & Privacy
→Privacy
- Click
+
sign and add the preferredIDE
andTerminal
in the following sections in left pane.-
Microphone
- Required to listen and respond. -
Accessibility
- Required to use key combinations for brightness and volume controls. -
Camera
- [Optional] Required only during face recognition/detection. -
Automation
- Required to controlSystem Events
and other apps like Outlook and Calendar. -
Files and Folders
[OR]Full Disk Access
- Required for allFileIO
operations.
-
-
-
Linux
Tested on Ubuntu 22.04 LTS- Store the host machine's password as the env var:
ROOT_PASSWORD
- Unlike macOS and Windows,
Ubuntu
does not have app specific permissions.
- Store the host machine's password as the env var:
-
Windows
Tested on Windows 10-
Settings
→Privacy
-
Microphone
- Required to listen and respond. -
Camera
- [Optional] Required only during face recognition/detection. - Unlike
macOS
,Windows
pops a confirmation window to Allow or Deny access to files and folders.
-
- Install Anaconda or Miniconda, VisualStudio C++ BuildTools, and Git
- Make sure C++ build tools are installed completely and restart
- Add anaconda/miniconda scripts location to
PATH
in Environment Variables
-
Enchiridion
Handbook - GitHub Wiki
Coding Standards
Docstring format: Google
Styling conventions: PEP 8
and isort
Release Notes
Requirement
python -m pip install gitverse
Usage
gitverse-release reverse -f release_notes.rst -t 'Release Notes'
Linting
pre-commit
will ensure linting, run pytest, generate runbook & release notes, and validate hyperlinks in ALL
markdown files (including Wiki pages)
Requirement
pip install sphinx==5.1.1 pre-commit recommonmark
Usage
pre-commit run --all-files
Pypi Package
https://pypi.org/project/jarvis-ironman/
Runbook
https://jarvis-docs.vigneshrao.com/
License & copyright
© Vignesh Rao
Licensed under the MIT License