This is Erikwonda, a command-line virtual assistant for programmers aimed to have versatile functionalities done on the terminal without having to browse everything on the Internet. With the tap of a key, Erikwonda is being built to bring the Internet to the terminal (and not to replace it though). Erikwonda was built with APIs such as The Guardian API and The Free Dictionary API
- Verifies if a word is an actual English, Russian, Chinese, German, Spanish or French word from SQL databases having [274k+ - 1.6M+] words
- Defines any English word with all its meanings, pronunciations, synonyms and antonyms in the dictionary.
- Gives users a list of recent news of different sections (Business, Technology, World News etc.) from The Guardian using The Guardian API.
- *Verifies if a person is eligible for a Full License, Provisional License, or a Learner's Permit from all 50 states of America.
- **Strikes up a conversation with a user.
- Prints out jokes, commonly referred to as Dad Jokes.
- User can add or remove events in their TODO lists. If not deleted (that is, crossed out realistically), users can always pull up their TODO lists as specified
To use Erikwonda, go to your command terminal. This README will assume you are at the file directory of the repo in your terminal. In order to use Erikwonda, a keyword will be needed as shown below:
python erikwonda.py [KEYWORD]
where [KEYWORD] returns the desired feature.
To see all commands, type:
python main.py help
and you will see a list of functions as outlined below:
KEYWORDS FUNCTIONS
-------------------------------------------------------------------------------------------------------------------------------------
about Returns the purpose of the assistant and a description of the author.
news Returns a list of recent news of different sections (Business, Tech etc.) from The Guardian using The Guardian API.
define Returns definitions, synonyms and antonyms of a word using the Free Dictionary API
help Returns a list of command-line arguments to type to implement the functionalities
check Checks if user input is a word in English, Chinese, Russian, German, Japanese, French or Spanish
eligible Checks if user is eligbile for a Full Licence, Provisional License or Learner's Permit in all 50 states of America
hello, howdy, hey Prompts erikwonda to start a conversation with user
add_todo Add events into a TODO list for user
see_todo Returns a list of events added to TODO list
remove_todo Allows user to remove events from TODO list
weather Returns the weather for the user's city of residence
To use the news keyword, user must retrieve an apikey from The Guardian and add to your ENVIRONMENT_VARIABLES.
If you are using PowerShell, type in the terminal:
$env:GUARDIAN_APIKEY = api_key
If you are using Bash or Linux, type in the shell:
export GUARDIAN_APIKEY = api_key
In addition, copy the directory (file_path) of where theis repo is located in your computer and add it to the ENVIRONMENT_VARIABLES:
If you are using PowerShell, type in the terminal:
$env:FILE_PATH = file_path
If you are using Bash or Linux, type in the shell:
export FILE_PATH = file_path
where file_path is the path of the repo in your computer.
Here is a walkthrough of Erikwonda:
GIF created byCloudConvert
- Implement more functionalities
- Leverage the use of APIs to make it more sophisticated
- Improve aesthetics
- *Data used for the license detector was gotten from The Word Population Review
- **Erikwonda is currently under active development
Please refer to CREDITS.md to see the people that made this project possible
If you have any problems or issues or suggestions, report any issues to [email protected] 🤝