Jarvis

<p align="center" style="text-align: center"> <img src="https://thevickypedia.github.io/open-source/images/logo/jarvis.png" width="371px" height="350px" alt="logo"> </p> <h2 align="center">Voice-Activated Natural Language UI</h2>

[![OpenSSF Scorecard][label-open-ssf]][link-open-ssf]

Platform Supported

Language Stats

Repo Stats

Code Stats

Deployments

![pypi][label-actions-pypi] ![resolver][label-actions-resolver] ![scan][label-actions-codeql]

![markdown][label-actions-markdown] ![update-release-notes][label-actions-release] ![pages][label-actions-pages] ![stale][label-actions-stale]

jarvis-ironman

![Pypi][label-pypi-jarvis-ironman] ![Pypi-format][label-pypi-format-jarvis-ironman] ![Pypi-status][label-pypi-status-jarvis-ironman]

jarvis-nlp

![Pypi][label-pypi-jarvis-nlp] ![Pypi-format][label-pypi-format-jarvis-nlp] ![Pypi-status][label-pypi-status-jarvis-nlp]

jarvis-bot

![Pypi][label-pypi-jarvis-bot] ![Pypi-format][label-pypi-format-jarvis-bot] ![Pypi-status][label-pypi-status-jarvis-bot]

natural-language-ui

![Pypi][label-pypi-natural-language-ui] ![Pypi-format][label-pypi-format-natural-language-ui] ![Pypi-status][label-pypi-status-natural-language-ui]

Activity

![GitHub Repo created][label-github-repo-created] ![GitHub commit activity][label-github-commit-activity] ![GitHub last commit][label-github-last-commit] ![GitHub last release][label-github-last-release]

Development and Maintenance

![Active Development][label-active-development] ![Actively Maintained][label-actively-maintained] ![Maintainer][label-maintainer]

Reach Out

![askme][label-askme]

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 <br> Tested on Mojave, Catalina, Big Sur, Monterey and Ventura

  • System Preferences → Security & Privacy → Privacy
  • Click + sign and add the preferred IDE and Terminal 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 control System Events and other apps like Outlook and Calendar.
    • Files and Folders [OR] Full Disk Access - Required for all FileIO operations.

• Linux <br> 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.

• Windows <br> 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 <br> 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 pre-commit recommonmark

Usage

pre-commit run --all-files

Pypi Package

• https://pypi.org/project/jarvis-ironman/
• https://pypi.org/project/jarvis-nlp/
• https://pypi.org/project/jarvis-bot/
• https://pypi.org/project/natural-language-ui/

Runbook

https://jarvis-docs.vigneshrao.com/

License & copyright

© Vignesh Rao

Licensed under the MIT License

<!-- labels -->