Tenant-Rights-Bot / README.md
Ultimatedeveloper1011's picture
Update README.md
284f619 verified
---
title: Tenant Rights Bot
emoji: ๐Ÿ 
colorFrom: blue
colorTo: green
sdk: gradio
sdk_version: 5.23.0
app_file: app.py
pinned: false
---
# Tenant Rights Bot
A Gradio app to answer questions about landlord-tenant laws across U.S. states, grounded in legal statutes.
## How to Use
1. Enter your OpenAI API key (get one from [OpenAI](https://platform.openai.com/api-keys)).
2. Select a U.S. state from the dropdown.
3. Ask your question about landlord-tenant laws (e.g., "What are the eviction rules in California?").
4. View the response, which will include citations to relevant statutes.
## Features
- Answers are grounded in state-specific legal statutes.
- Supports all U.S. states with data from a comprehensive landlord-tenant law document.
- Provides practical examples to help users understand the laws.
## Requirements
- An OpenAI API key is required to use the app.
- The app uses the `gpt-3.5-turbo` model for generating answers.
## License
This project is licensed under the [OpenRAIL License](https://huggingface.co/spaces/license/OpenRAIL).
## Note
This app is for informational purposes only and is not a substitute for legal advice. Always consult a legal professional for specific legal issues.