https://github.com/forchapeatl/baseballwiki
https://github.com/forchapeatl/baseballwiki
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/forchapeatl/baseballwiki
- Owner: Forchapeatl
- Created: 2025-02-04T21:20:37.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-04T21:24:06.000Z (4 months ago)
- Last Synced: 2025-02-04T22:25:03.136Z (4 months ago)
- Language: Python
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Here’s a **README.md** for your **Baseball Wiki** project with installation instructions:
### Set up a Virtual Environment
```bash
python3 -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
```
### Install Dependencies
```bash
pip install -r requirements.txt
```
### Set Google Cloud Credentials
Make sure you have the **Google Cloud credentials** set:
```bash
export GOOGLE_APPLICATION_CREDENTIALS="/path/to/your/google-credentials.json"
```
Or include directly in app.py
https://github.com/Forchapeatl/baseballWiki/blob/eadac4099b144fd3f094e9e78bdd5b24a0e55dbf/app.py#L38
### Set up FAISS and LangChain
1. Ensure you have **FAISS** installed by following the official instructions from [FAISS documentation](https://github.com/facebookresearch/faiss).
2. Set up **LangChain**:
```bash
pip install langchain langchain-google
```
### Start Flask Server
```bash
python app.py
```
The Flask server should now be running locally. Open your browser and go to `http://127.0.0.1:5000` to interact with the app.
### Usage
1. Go to the **Baseball Wiki** app.
2. Click on a player card and then click **"Chat with Bot"**.
3. Ask questions like: **"What is Shohei Ohtani’s batting average?"** and the chatbot will respond with relevant player data.
## Contributing
Feel free to fork the repository, make improvements, and create pull requests. If you have any suggestions or find bugs, please open an issue.
## License
This project is licensed under the MIT License - see the [MIT LICENSE](https://opensource.org/license/mit) file for details.
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.