|
| 1 | +# Python Chatbot |
| 2 | +Hello, and welcome to Python Chatbot! This program was made by Kapilesh Pennichetty and Sanjay Balasubramanian. Through user interaction, it can do the following: |
| 3 | + |
| 4 | +- Store and return the user's name using global variable "name". |
| 5 | +- Retrieve the weather of a location automatically using an IP address or manually with a user input* |
| 6 | +- Retrieve the introduction to a Wikipedia article |
| 7 | +- Play an interactive story, where you decide how the character reacts to different scenarios |
| 8 | + |
| 9 | +*Please note that if you are going to use the automatic IP address function, you must run it on a local machine for accurate results. This is because the program needs your IP address to accurately find your location, and then it uses your location to retrieve the weather. Also, please disable your VPN or Internet Proxy for accurate results. |
| 10 | + |
| 11 | +Also, please note that you will need to have Python 3.7 or newer with pip to run this program. |
| 12 | + |
| 13 | +To operate the chatbot, you must first install these dependencies for the chatbot to be functional: |
| 14 | + |
| 15 | +- Wikipedia API |
| 16 | + |
| 17 | + - For Windows users: |
| 18 | + - Open the command prompt and type: |
| 19 | + ```shell |
| 20 | + pip3 install wikipedia-api |
| 21 | + ``` |
| 22 | + - For POSIX (including macOS and Linux) users: |
| 23 | + - Open the terminal and type: |
| 24 | + ```shell |
| 25 | + $ python -m pip install wikipedia-api |
| 26 | + ``` |
| 27 | + |
| 28 | +- PyOWM |
| 29 | + |
| 30 | + - For Windows users: |
| 31 | + - Open the command prompt and type: |
| 32 | + ```shell |
| 33 | + pip install pyowm |
| 34 | + ``` |
| 35 | + - For POSIX (including macOS and Linux) users: |
| 36 | + - Open the terminal and type: |
| 37 | + ```shell |
| 38 | + $ python -m pip install pyowm |
| 39 | + ``` |
| 40 | + |
| 41 | +- IPStack for Python (Geo Location Library) |
| 42 | + |
| 43 | + - For Windows users: |
| 44 | + - Open the command prompt and type: |
| 45 | + ```shell |
| 46 | + pip install ipstack |
| 47 | + ``` |
| 48 | + - For POSIX (including macOS and Linux) users: |
| 49 | + - Open the terminal and type: |
| 50 | + ```shell |
| 51 | + $ python -m pip install pyowm |
| 52 | + ``` |
| 53 | + |
| 54 | +Then, download this repository, and run the "main.py" file to start interacting with the chatbot! |
| 55 | + |
| 56 | +Please note that the program is currently in a beta stage, and that there may be issues with the program. Please feel free to send us feedback on our program. |
| 57 | + |
| 58 | +Thank you for using Python Chatbot! We hope you enjoy using it! |
| 59 | + |
| 60 | +# Sources |
| 61 | +**Special thanks to Mr. Bailey Hulsey for his contributions and for sharing his knowledge of computer science to noobs like us!** |
| 62 | + |
| 63 | +- Wikipedia API and Documentation: https://github.com/martin-majlis/Wikipedia-API |
| 64 | +- Wikipedia: https://wikipedia.org |
| 65 | +- OpenWeatherMap Raw API and Documentation: https://openweathermap.org/current |
| 66 | +- OpenWeatherMap Python Library and Documentation: https://github.com/csparpa/pyowm |
| 67 | +- ipstack Raw API and Documentation: https://ipstack.com/documentation |
| 68 | +- ipstack Python Library and Documentation: https://github.com/nathan-fiscaletti/ipstackgeo-py |
0 commit comments