Skip to content

Latest commit

 

History

History
146 lines (111 loc) · 6.91 KB

README.md

File metadata and controls

146 lines (111 loc) · 6.91 KB
Raw

Open-Source Windows Voice Assistant

September is an open-source Windows personal assistant built-in python.
Download Zip File
Download Windows Installer

Read & Follow these before using September

september load page

⚙️ Setting up the application (Must Read, Don't Skip these)

🖥️ Keybinds

Key Functionality
Escape Stops the assistant from speaking the current dialogue
Enter Reads the input from the command entry box.
(Works only when the command entry box is focussed)
Alt + F4 Quits the application

🎙️ Wake word

  • You can make September respond to a custom wake word.
  • By default, the wake word is September
  • You can change it in the settings. settings

💾 Recommended Configuration

  • Windows 10
  • 1080p resolution
  • RAM >1GB
  • Note: These are just recommended requirements. Your PC might still support September without these.

😎 Cool Things to Try

open notepad

search for stock market crash on google

play gangnam style 

flip a coin

repeat rage, rage against the dying of the light!

photosynthesis from wikipedia

what is the lifespan of a housefly

📝 License

MIT License

Copyright (c) 2022 Nithin Balaji

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

The Basic Question Answering Ability will break if you skip this step

  • This app depends on Wolfram Alpha - a computational knowledge engine and answer engine developed by Wolfram Research.
  • The app comes with a default sample API key which is required for the Wolfram Alpha engine to function. This will become outdated after some time.
  • To keep September working, you are required to generate your API key and update it in the app settings.
  • Note: Features like opening apps, searching web, playing from youtube etc. doesn't require the usage of this API.

Steps to create and enter the new API key

appid created

  • Copy that API key. The key in the above image is a sample API key. Do not use that value.
  • Go to September app settings to update the WOLFAPI KEY value. settings
  • Select WOLFAPI KEY in the settings dropdown menu and
    enter your copied app id in the ENTER NEW VALUE BOX and click update.

api key in settings

When to change my API key again

  • You can track your API status at https://developer.wolframalpha.com/portal/myapps
  • Once you cross 2K monthly requests, you need to create a new API key and update it in the settings.
  • You need not change your API key if your monthly usage is less than 2K requests.
  • Note: Features like opening apps, searching web, playing from youtube etc. doesn't require the usage of this API.

September won't be able to open apps and browsers if you skip this step

  • You can command September to open some default apps, chrome & edge browsers, and even search Google, Youtube, and Wikipedia.
  • For this to work properly, you need to go to settings and ensure that the app paths are correct. (The default app paths will work in most of the systems)
  • You can change those paths by entering a new value and clicking update in settings. settings

Additional Debugging

  • Sometimes the antivirus software may hinder September from uploading & downloading audio stream data or listening to the microphone. Make sure you trust the application in your antivirus software settings if the voice detection doesn't work.
  • Requires active internet connection to function.
  • Make sure that your mic and speaker are in proper working condition.