-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Created Redme File
- Loading branch information
Showing
1 changed file
with
58 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,58 @@ | ||
"# Chat-With-CSV" | ||
# Chat with CSV 🤖📊💬 | ||
|
||
## Description | ||
|
||
Chat with CSV is an interactive tool designed to enable users to upload CSV files and perform commands or queries on the data within the CSV file. It serves as an analytic tool, allowing users to interact with their data using natural language commands. | ||
|
||
## Table of Contents | ||
|
||
1. [Installation](#installation) | ||
2. [Usage](#usage) | ||
3. [Contributing](#contributing) | ||
|
||
## Installation | ||
|
||
To install Chat with CSV, follow these steps: | ||
|
||
1. Clone the repository: | ||
|
||
```bash | ||
git clone https://github.com/aremstrom/chat-with-csv.git | ||
``` | ||
|
||
2. Navigate to the project directory: | ||
|
||
```bash | ||
cd chat-with-csv | ||
``` | ||
|
||
3. Install the required dependencies: | ||
|
||
```bash | ||
pip install -r requirements.txt | ||
``` | ||
|
||
## Usage | ||
|
||
1. Run the application: | ||
|
||
```bash | ||
streamlit run app.py | ||
``` | ||
|
||
2. Upload your CSV file when prompted. | ||
|
||
3. Start typing your commands or queries in the chat interface. | ||
|
||
4. Get responses based on your input commands or queries. | ||
|
||
## Contributing | ||
|
||
Contributions are welcome! Here's how you can contribute: | ||
1. Fork the repository. | ||
2. Create a new branch (`git checkout -b feature-new-feature`). | ||
3. Make your changes. | ||
4. Commit your changes (`git commit -am 'Add new feature'`). | ||
5. Push to the branch (`git push origin feature-new-feature`). | ||
6. Create a new Pull Request. |