Voice-Activated Natural Language UI
Project description
Voice-Activated Natural Language UI
Platform Supported
Language Stats
Code Stats
Deployments
Activity
Development and Maintenance
Reach Out
Kick off
Recommendations
- Install
python
3.10 or 3.11 - Use a dedicated virtual environment
Install Jarvis
python -m pip install jarvis-ironman
Install Dependencies
jarvis install
Initiate - IDE
import jarvis
if __name__ == '__main__':
jarvis.start()
Initiate - CLI
jarvis start
Use
jarvis --help
for usage instructions.
Prerequisites
-
MacOS
Tested on Mojave, Catalina, Big Sur, Monterey and VenturaSystem 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 10Settings
→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
python -m 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for jarvis_ironman-6.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 929ef23d27559286ac26c60ced9ffd1b5b99b221712afadebb6d0feb6e4e146c |
|
MD5 | 42ff5accfbe83390a9059c95728abdea |
|
BLAKE2b-256 | be0c46a1d8a60a7b473ba8bed66b5e82fa042c7841d2e949d0a9b978d73b3cc4 |