atharv-16 commited on
Commit
bf2c863
·
verified ·
1 Parent(s): 7b744e5

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +73 -67
README.md CHANGED
@@ -1,67 +1,73 @@
1
- # Autonomous Calendar Assistant
2
-
3
- An AI-powered calendar assistant that helps you manage your schedule, find optimal meeting times, and automate calendar operations using natural language commands.
4
-
5
- ## Features
6
-
7
- - Natural language understanding for calendar commands
8
- - Intelligent scheduling based on your preferences
9
- - Meeting finding, scheduling, and management
10
- - Availability checking and optimization
11
-
12
- ## How to Use
13
-
14
- 1. Click the "Login with Google Calendar" button
15
- 2. Follow the authorization flow to grant access
16
- 3. Start using natural language commands like:
17
- - "Schedule a meeting with Alex tomorrow at 2pm"
18
- - "Find all meetings with Morgan"
19
- - "When am I free next Monday?"
20
-
21
- ## Authentication
22
-
23
- This app requires Google Calendar API credentials and OAuth authentication.
24
-
25
- ## Docker Setup
26
-
27
- ### Prerequisites
28
-
29
- - Docker and Docker Compose installed
30
- - Google Calendar API credentials
31
-
32
- ### Setup Instructions
33
-
34
- 1. **Prepare your credentials**
35
-
36
- Place your `credentials.json` file in the `credentials` directory. If the directory doesn't exist, create it:
37
-
38
- ```bash
39
- mkdir -p credentials
40
- # Copy your credentials.json file to the credentials directory
41
- ```
42
-
43
- 2. **Build and run with Docker Compose**
44
-
45
- ```bash
46
- docker-compose up -d
47
- ```
48
-
49
- 3. **Access the application**
50
-
51
- Open your browser and navigate to: `http://localhost:8501`
52
-
53
- ### Environment Variables
54
-
55
- You can customize the application by setting these environment variables in the docker-compose.yml file:
56
-
57
- - `GOOGLE_APPLICATION_CREDENTIALS`: Path to the Google credentials file
58
- - `TZ`: Timezone (default: Asia/Kolkata)
59
-
60
- ## Running Locally Without Docker
61
-
62
- If you prefer to run without Docker:
63
-
64
- 1. Install Python 3.9 or higher
65
- 2. Install dependencies: `pip install -r requirements.txt`
66
- 3. Place your credentials.json file in the project directory
67
- 4. Run: `streamlit run app.py`
 
 
 
 
 
 
 
1
+ ---
2
+ title: Calendar Assistant
3
+ emoji: 📅
4
+ colorFrom: blue
5
+ colorTo: indigo
6
+ sdk: streamlit
7
+ sdk_version: "1.24.0"
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
+
12
+ # Autonomous Calendar Assistant
13
+
14
+ An AI-powered calendar assistant that helps you manage your schedule, find optimal meeting times, and automate calendar operations using natural language commands.
15
+
16
+ ## Features
17
+
18
+ - Natural language understanding for calendar commands
19
+ - Intelligent scheduling based on your preferences
20
+ - Meeting finding, scheduling, and management
21
+ - Availability checking and optimization
22
+
23
+ ## How to Use
24
+
25
+ 1. Click the "Login with Google Calendar" button
26
+ 2. Follow the authorization flow to grant access
27
+ 3. Start using natural language commands like:
28
+ - "Schedule a meeting with Alex tomorrow at 2pm"
29
+ - "Find all meetings with Morgan"
30
+ - "When am I free next Monday?"
31
+
32
+ ## Authentication
33
+
34
+ This app requires Google Calendar API credentials and OAuth authentication.
35
+
36
+ ## Docker Setup
37
+
38
+ ### Prerequisites
39
+
40
+ - Docker and Docker Compose installed
41
+ - Google Calendar API credentials
42
+
43
+ ### Setup Instructions
44
+
45
+ 1. **Prepare your credentials**
46
+
47
+ Place your `credentials.json` file in the `credentials` directory.
48
+
49
+ 2. **Build and run with Docker Compose**
50
+
51
+ ```bash
52
+ docker-compose up -d
53
+ ```
54
+
55
+ 3. **Access the application**
56
+
57
+ Open your browser and navigate to: `http://localhost:8501`
58
+
59
+ ### Environment Variables
60
+
61
+ You can customize the application by setting these environment variables in the docker-compose.yml file:
62
+
63
+ - `GOOGLE_APPLICATION_CREDENTIALS`: Path to the Google credentials file
64
+ - `TZ`: Timezone (default: Asia/Kolkata)
65
+
66
+ ## Running Locally Without Docker
67
+
68
+ If you prefer to run without Docker:
69
+
70
+ 1. Install Python 3.9 or higher
71
+ 2. Install dependencies: `pip install -r requirements.txt`
72
+ 3. Place your credentials.json file in the project directory
73
+ 4. Run: `streamlit run app.py`