| Name | whenami JSON |
| Version |
0.2.1
JSON |
| download |
| home_page | None |
| Summary | A powerful Google Calendar tool that merges multiple calendars to find your true availability across work and personal schedules |
| upload_time | 2025-07-17 13:30:45 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" means the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" means any form resulting from mechanical transformation or
translation of a Source form, including but not limited to compiled
object code, generated documentation, and conversions to other media
types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(which shall not include communication that is prominently marked
or otherwise designated in writing by the copyright owner as
"Not a Work").
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based upon (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and derivative works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf
of, the Licensor for the purpose of discussing and improving the Work,
but excluding communication that is prominently marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to use, reproduce, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Work, and to
permit persons to whom the Work is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Work.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, trademark, patent,
attribution and other notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright notice to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Disclaimer of Warranty. UNLESS REQUIRED BY APPLICABLE LAW OR
AGREED TO IN WRITING, LICENSOR PROVIDES THE WORK (AND EACH
CONTRIBUTOR PROVIDES ITS CONTRIBUTIONS) ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS
OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
7. Limitation of Liability. IN NO EVENT AND UNDER NO LEGAL THEORY,
WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE,
UNLESS REQUIRED BY APPLICABLE LAW (SUCH AS DELIBERATE AND GROSSLY
NEGLIGENT ACTS) OR AGREED TO IN WRITING, SHALL ANY CONTRIBUTOR BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, INDIRECT, SPECIAL,
INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER ARISING AS A
RESULT OF THIS LICENSE OR OUT OF THE USE OR INABILITY TO USE THE
WORK (INCLUDING BUT NOT LIMITED TO DAMAGES FOR LOSS OF GOODWILL,
WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL
OTHER COMMERCIAL DAMAGES OR LOSSES), EVEN IF SUCH CONTRIBUTOR
HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
8. Accepting Warranty or Support. You may choose to offer and charge a
fee for, warranty, support, indemnity or other liability obligations
and/or rights consistent with this License. However, in accepting such
obligations, You may act only on Your own behalf and on Your sole
responsibility, not on behalf of any other Contributor, and only if
You agree to indemnify, defend, and hold each Contributor harmless for
any liability incurred by, or claims asserted against, such Contributor
by reason of your accepting any such warranty or support.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in comments for the
particular programming language. You may also want to include a
copyright notice such adjacent to the appropriate year(s).
Copyright 2025 Lucas Zampieri
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. |
| keywords |
calendar
google-calendar
productivity
scheduling
time-management
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Whenami
A powerful Google Calendar tool that merges multiple calendars to find your true availability across work and personal schedules.
<img alt="Whenami demo" src="https://raw.githubusercontent.com/zampierilucas/whenami/master/demo.gif" />
## Description
whenami is a command-line tool designed for people who juggle multiple calendars (work, personal, side projects, etc.). Its key strength is **merging multiple Google Calendars** to show your real availability by combining busy periods from all sources.
### Key Features:
- **🗓️ Multi-calendar support**: Connect work calendars, personal Gmail calendars, shared calendars
- **🔀 Smart merging**: Automatically merges busy periods from all calendars to show true availability
- **🤖 AI-powered natural language (optional)**: Use plain English to query your calendar - "free tomorrow", "busy next week"
- **⏰ Flexible time filtering**: Personal hours (awake time), work hours, or 24/7 view
- **🎨 Color-coded output**: Green for free slots, red for busy periods
- **🌍 Advanced timezone handling**: Automatically detects each calendar's timezone, merges events correctly across timezones, and converts output to any timezone
- **📅 Multiple date ranges**: Today, tomorrow, next week, or custom date ranges with flexible date formats
Perfect for professionals who need to see availability across multiple calendars without manually checking each one.
## Installation
### From PyPI (Recommended)
```bash
pip install whenami
```
After installation, you can run the tool directly:
```bash
whenami --help
```
**Optional AI features**: LLM support is disabled by default. To enable natural language queries, see the [AI-Powered Natural Language Queries](#ai-powered-natural-language-queries-optional) section below.
### Local Development Setup
For local development or running from source:
#### Prerequisites
- Python 3.7+
#### Setup
```bash
# Clone the repository
git clone https://github.com/zampierilucas/whenami.git
cd whenami
# Create virtual environment
python -m venv .venv
source .venv/bin/activate
# Install in development mode with dev dependencies
pip install -e ".[dev]"
# Run the tool directly (after installation)
whenami --help
# Or run from source
python src/whenami/main.py --help
```
## AI-Powered Natural Language Queries (Optional)
whenami supports **optional** natural language processing using LLM models via [litellm](https://github.com/BerriAI/litellm), allowing you to query your calendar using plain English. Works with **any LLM service** including OpenAI, Claude, local Ollama, or custom APIs.
**Note**: LLM features are **disabled by default** and require manual configuration to enable.
### Quick Examples
```bash
# Natural language queries
whenami "free tomorrow"
whenami "busy next week"
whenami "work hours today"
whenami "personal time on 15/07/25"
whenami "show me August 2025"
# With debug output to see LLM processing
whenami "free tomorrow" --debug
```
### Setup LLM Features
#### Option 1: Local Ollama (Recommended)
```bash
# Visit https://ollama.ai for installation instructions
# Or on macOS:
brew install ollama
# Pull a model (recommended: llama3.2 or llama3.3)
ollama pull llama3.3
# Configure in config.json:
{
"llm": {
"model": "ollama/llama3.3",
"api_base": "http://localhost:11434",
"enabled": true
}
}
```
#### Option 2: OpenAI API
```json
{
"llm": {
"model": "gpt-4o-mini",
"api_base": "https://api.openai.com/v1",
"enabled": true
}
}
```
Set your API key: `export OPENAI_API_KEY="your-key-here"`
#### Option 3: Claude API
```json
{
"llm": {
"model": "claude-3-haiku-20240307",
"api_base": "https://api.anthropic.com",
"enabled": true
}
}
```
Set your API key: `export ANTHROPIC_API_KEY="your-key-here"`
#### Option 4: Any Custom LLM Service
litellm supports 100+ LLM providers. See [litellm docs](https://docs.litellm.ai/docs/providers) for configuration examples.
### LLM Management Commands
```bash
# Show current LLM configuration
whenami --llm-config
# Test LLM connectivity with default query
whenami --llm-test
# Test with custom query
whenami --llm-test "busy next week"
# Get setup help and examples
whenami --llm-help
```
### Natural Language Examples
| Input | Converts To |
|-------|-------------|
| `"free tomorrow"` | `--tomorrow --free` |
| `"busy next week"` | `--next-week --busy` |
| `"work hours today"` | `--today --work-hours` |
| `"personal time on 15/07/25"` | `--date "15/07/25" --personal-hours` |
| `"show me August 2025"` | `--date-range "01/08/2025,31/08/2025"` |
| `"free weekdays next week"` | `--next-week --work-days --free` |
| `"tomorrow in New York time"` | `--tomorrow --convert-tz America/New_York` |
| `"today in Tokyo timezone"` | `--today --convert-tz Asia/Tokyo` |
The AI understands context, dates, time preferences, and complex queries, making calendar management more intuitive.
## Usage
### Natural Language Queries (Optional)
```bash
# Simple natural language - AI converts to appropriate commands (requires LLM setup)
whenami "free tomorrow"
whenami "busy next week"
whenami "work hours today"
whenami "personal time on 25/12/25"
whenami "show me next month"
whenami "tomorrow in New York time"
whenami "today in Tokyo timezone"
# Natural language with debug to see conversion
whenami "free tomorrow" --debug
```
### Traditional Command Line Options
```bash
# Show only free slots for today (default)
whenami
# Show only free slots (same as default)
whenami --free --today
# Show only busy slots
whenami --busy --today
# Split busy and free slots into separate sections
whenami --today --split
# Show free slots for tomorrow
whenami --tomorrow
# Show free slots for next week work days(default mon-fri)
whenami --next-week --work-days
# Show free slots during work hours only
whenami --today --work-hours
# Show free slots during personal hours (default: 8-22)
whenami --today --personal-hours
# Show all hours (24/7, no time filtering)
whenami --today --all-hours
# Custom dates (supports DD/MM/YYYY, DD/MM/YY, DD-MM-YYYY, DD-MM-YY)
whenami --date "25/12/2025"
whenami --date "25/12/25"
whenami --date "25-12-2025"
# Date ranges
whenami --date-range "01/08/2025,31/08/2025"
whenami --date-range "01/08/25,31/08/25"
# Convert output to a specific timezone
whenami --today --convert-tz America/Sao_Paulo
# Show event names alongside busy slots
whenami --today --event-name
# Show event names with split view
whenami --today --event-name --split
# List available timezones
whenami --list-tz
```
## Timezone Support
whenami intelligently handles complex timezone scenarios:
### **Multi-Timezone Calendar Merging**
- **Auto-detection**: Automatically detects each calendar's native timezone (e.g., work calendar in EST, personal in PST)
- **Smart merging**: Converts all events to a common timezone before merging busy periods
- **Accurate overlap detection**: Ensures proper conflict detection across timezone boundaries
### **Flexible Output Conversion**
```bash
# View in your local timezone (default)
whenami --today
# Convert to a specific timezone for travel/meetings
whenami --today --convert-tz Europe/London
whenami --next-week --convert-tz Asia/Tokyo
# List all available timezones
whenami --list-tz
```
### **Real-World Example**
If you have:
- Work calendar in `America/New_York` (EST/EDT)
- Personal calendar in `America/Los_Angeles` (PST/PDT)
- University calendar in `Europe/London` (GMT/BST)
whenami will automatically handle the conversions and show your true availability across all timezones, optionally converting the final output to any timezone you specify.
## Configuration
The tool will automatically create a `~/.config/whenami/` directory for storing configuration files. You can place your configuration files there for system-wide access, or use the current directory for project-specific configurations.
1. Copy the example config file:
```bash
cp config.json.example ~/.config/whenami/config.json
```
2. Edit `config.json` with your calendar settings:
```json
{
"calendars": [
{
"id": "your-work-email@company.com",
"name": "Work Calendar"
},
{
"id": "your-personal@gmail.com",
"name": "Personal Calendar"
},
{
"id": "shared-project@company.com",
"name": "Shared Project Calendar"
},
{
"id": "student.name@university.edu",
"name": "University Calendar"
}
],
"work_hours": {
"start": "09:00",
"end": "17:00"
},
"personal_hours": {
"start": "08:00",
"end": "22:00"
},
"minimum_slot_duration": 30,
"default_timezone": "Europe/Dublin"
}
```
### Configuration Options
- **`calendars`**: Array of calendar objects with `id` and `name` fields
- **`work_hours`**: Define work hours (start/end times in 24-hour format)
- **`personal_hours`**: Define personal hours (start/end times in 24-hour format)
- **`minimum_slot_duration`**: Minimum duration in minutes for free slots to be displayed
- **`default_timezone`**: Default timezone for date calculations (e.g., "Europe/Dublin", "America/New_York", "UTC")
- **`llm`**: **(Optional)** LLM configuration for natural language processing - disabled by default
- **`model`**: Model to use (e.g., "ollama/llama3.3", "gpt-4o-mini", "claude-3-haiku-20240307")
- **`api_base`**: LLM server endpoint (varies by provider, see setup examples above)
- **`enabled`**: Enable/disable LLM features (false by default)
**📝 Note**: Add as many calendars as needed - the tool will merge all busy periods to show your true availability across all calendars. This is especially useful if you have separate work, personal, and project calendars that you need to coordinate.
The `default_timezone` setting controls the timezone used for date calculations (e.g., "today", "tomorrow"). If not specified, the tool will try to use your system's timezone, falling back to UTC.
## Authentication
The tool requires Google Calendar API authentication:
1. Go to [Google Cloud Console](https://console.cloud.google.com/)
2. Create a new project or select an existing one
3. Enable the Google Calendar API
4. Create OAuth 2.0 credentials (Desktop application)
5. Download the credentials and save as `credentials.json` in one of these locations:
- `~/.config/whenami/credentials.json` (recommended for system-wide access)
- `./credentials.json` (current directory, for project-specific setup)
The first time you run the tool, it will open a browser window for authentication. The authentication token will be saved in `~/.config/whenami/token.json` for future use.
## Development
This project uses GitHub Actions for CI/CD:
- **CI Pipeline**: Runs tests on Python 3.9-3.12, generates coverage reports, and validates builds
- **PyPI Publishing**: Automated publishing to PyPI on releases using trusted publishing
For development setup, see the [Local Development Setup](#local-development-setup) section above.
Raw data
{
"_id": null,
"home_page": null,
"name": "whenami",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "calendar, google-calendar, productivity, scheduling, time-management",
"author": null,
"author_email": "Lucas Zampieri <lcasmz54@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/55/8c/ed390006dedc45f6221ee482ef2916ea269e314910a0ae639457b871f907/whenami-0.2.1.tar.gz",
"platform": null,
"description": "# Whenami\n\nA powerful Google Calendar tool that merges multiple calendars to find your true availability across work and personal schedules.\n\n<img alt=\"Whenami demo\" src=\"https://raw.githubusercontent.com/zampierilucas/whenami/master/demo.gif\" />\n\n## Description\n\nwhenami is a command-line tool designed for people who juggle multiple calendars (work, personal, side projects, etc.). Its key strength is **merging multiple Google Calendars** to show your real availability by combining busy periods from all sources.\n\n### Key Features:\n- **\ud83d\uddd3\ufe0f Multi-calendar support**: Connect work calendars, personal Gmail calendars, shared calendars\n- **\ud83d\udd00 Smart merging**: Automatically merges busy periods from all calendars to show true availability\n- **\ud83e\udd16 AI-powered natural language (optional)**: Use plain English to query your calendar - \"free tomorrow\", \"busy next week\"\n- **\u23f0 Flexible time filtering**: Personal hours (awake time), work hours, or 24/7 view\n- **\ud83c\udfa8 Color-coded output**: Green for free slots, red for busy periods\n- **\ud83c\udf0d Advanced timezone handling**: Automatically detects each calendar's timezone, merges events correctly across timezones, and converts output to any timezone\n- **\ud83d\udcc5 Multiple date ranges**: Today, tomorrow, next week, or custom date ranges with flexible date formats\n\nPerfect for professionals who need to see availability across multiple calendars without manually checking each one.\n\n## Installation\n\n### From PyPI (Recommended)\n```bash\npip install whenami\n```\n\nAfter installation, you can run the tool directly:\n```bash\nwhenami --help\n```\n\n**Optional AI features**: LLM support is disabled by default. To enable natural language queries, see the [AI-Powered Natural Language Queries](#ai-powered-natural-language-queries-optional) section below.\n\n### Local Development Setup\n\nFor local development or running from source:\n\n#### Prerequisites\n- Python 3.7+\n\n#### Setup\n```bash\n# Clone the repository\ngit clone https://github.com/zampierilucas/whenami.git\ncd whenami\n\n# Create virtual environment\npython -m venv .venv\nsource .venv/bin/activate\n\n# Install in development mode with dev dependencies\npip install -e \".[dev]\"\n\n# Run the tool directly (after installation)\nwhenami --help\n\n# Or run from source\npython src/whenami/main.py --help\n```\n\n## AI-Powered Natural Language Queries (Optional)\n\nwhenami supports **optional** natural language processing using LLM models via [litellm](https://github.com/BerriAI/litellm), allowing you to query your calendar using plain English. Works with **any LLM service** including OpenAI, Claude, local Ollama, or custom APIs.\n\n**Note**: LLM features are **disabled by default** and require manual configuration to enable.\n\n### Quick Examples\n```bash\n# Natural language queries\nwhenami \"free tomorrow\"\nwhenami \"busy next week\"\nwhenami \"work hours today\"\nwhenami \"personal time on 15/07/25\"\nwhenami \"show me August 2025\"\n\n# With debug output to see LLM processing\nwhenami \"free tomorrow\" --debug\n```\n\n### Setup LLM Features\n\n#### Option 1: Local Ollama (Recommended)\n```bash\n# Visit https://ollama.ai for installation instructions\n# Or on macOS:\nbrew install ollama\n\n# Pull a model (recommended: llama3.2 or llama3.3)\nollama pull llama3.3\n\n# Configure in config.json:\n{\n \"llm\": {\n \"model\": \"ollama/llama3.3\",\n \"api_base\": \"http://localhost:11434\",\n \"enabled\": true\n }\n}\n```\n\n#### Option 2: OpenAI API\n```json\n{\n \"llm\": {\n \"model\": \"gpt-4o-mini\",\n \"api_base\": \"https://api.openai.com/v1\",\n \"enabled\": true\n }\n}\n```\nSet your API key: `export OPENAI_API_KEY=\"your-key-here\"`\n\n#### Option 3: Claude API\n```json\n{\n \"llm\": {\n \"model\": \"claude-3-haiku-20240307\",\n \"api_base\": \"https://api.anthropic.com\",\n \"enabled\": true\n }\n}\n```\nSet your API key: `export ANTHROPIC_API_KEY=\"your-key-here\"`\n\n#### Option 4: Any Custom LLM Service\nlitellm supports 100+ LLM providers. See [litellm docs](https://docs.litellm.ai/docs/providers) for configuration examples.\n\n### LLM Management Commands\n```bash\n# Show current LLM configuration\nwhenami --llm-config\n\n# Test LLM connectivity with default query\nwhenami --llm-test\n\n# Test with custom query\nwhenami --llm-test \"busy next week\"\n\n# Get setup help and examples\nwhenami --llm-help\n```\n\n### Natural Language Examples\n\n| Input | Converts To |\n|-------|-------------|\n| `\"free tomorrow\"` | `--tomorrow --free` |\n| `\"busy next week\"` | `--next-week --busy` |\n| `\"work hours today\"` | `--today --work-hours` |\n| `\"personal time on 15/07/25\"` | `--date \"15/07/25\" --personal-hours` |\n| `\"show me August 2025\"` | `--date-range \"01/08/2025,31/08/2025\"` |\n| `\"free weekdays next week\"` | `--next-week --work-days --free` |\n| `\"tomorrow in New York time\"` | `--tomorrow --convert-tz America/New_York` |\n| `\"today in Tokyo timezone\"` | `--today --convert-tz Asia/Tokyo` |\n\nThe AI understands context, dates, time preferences, and complex queries, making calendar management more intuitive.\n\n## Usage\n\n### Natural Language Queries (Optional)\n```bash\n# Simple natural language - AI converts to appropriate commands (requires LLM setup)\nwhenami \"free tomorrow\"\nwhenami \"busy next week\"\nwhenami \"work hours today\"\nwhenami \"personal time on 25/12/25\"\nwhenami \"show me next month\"\nwhenami \"tomorrow in New York time\"\nwhenami \"today in Tokyo timezone\"\n\n# Natural language with debug to see conversion\nwhenami \"free tomorrow\" --debug\n```\n\n### Traditional Command Line Options\n```bash\n# Show only free slots for today (default)\nwhenami\n\n# Show only free slots (same as default)\nwhenami --free --today\n\n# Show only busy slots\nwhenami --busy --today\n\n# Split busy and free slots into separate sections\nwhenami --today --split\n\n# Show free slots for tomorrow\nwhenami --tomorrow\n\n# Show free slots for next week work days(default mon-fri)\nwhenami --next-week --work-days\n\n# Show free slots during work hours only\nwhenami --today --work-hours\n\n# Show free slots during personal hours (default: 8-22)\nwhenami --today --personal-hours\n\n# Show all hours (24/7, no time filtering)\nwhenami --today --all-hours\n\n# Custom dates (supports DD/MM/YYYY, DD/MM/YY, DD-MM-YYYY, DD-MM-YY)\nwhenami --date \"25/12/2025\"\nwhenami --date \"25/12/25\"\nwhenami --date \"25-12-2025\"\n\n# Date ranges\nwhenami --date-range \"01/08/2025,31/08/2025\"\nwhenami --date-range \"01/08/25,31/08/25\"\n\n# Convert output to a specific timezone\nwhenami --today --convert-tz America/Sao_Paulo\n\n# Show event names alongside busy slots\nwhenami --today --event-name\n\n# Show event names with split view\nwhenami --today --event-name --split\n\n# List available timezones\nwhenami --list-tz\n```\n\n## Timezone Support\n\nwhenami intelligently handles complex timezone scenarios:\n\n### **Multi-Timezone Calendar Merging**\n- **Auto-detection**: Automatically detects each calendar's native timezone (e.g., work calendar in EST, personal in PST)\n- **Smart merging**: Converts all events to a common timezone before merging busy periods\n- **Accurate overlap detection**: Ensures proper conflict detection across timezone boundaries\n\n### **Flexible Output Conversion**\n```bash\n# View in your local timezone (default)\nwhenami --today\n\n# Convert to a specific timezone for travel/meetings\nwhenami --today --convert-tz Europe/London\nwhenami --next-week --convert-tz Asia/Tokyo\n\n# List all available timezones\nwhenami --list-tz\n```\n\n### **Real-World Example**\nIf you have:\n- Work calendar in `America/New_York` (EST/EDT)\n- Personal calendar in `America/Los_Angeles` (PST/PDT)\n- University calendar in `Europe/London` (GMT/BST)\n\nwhenami will automatically handle the conversions and show your true availability across all timezones, optionally converting the final output to any timezone you specify.\n\n## Configuration\n\nThe tool will automatically create a `~/.config/whenami/` directory for storing configuration files. You can place your configuration files there for system-wide access, or use the current directory for project-specific configurations.\n\n1. Copy the example config file:\n```bash\ncp config.json.example ~/.config/whenami/config.json\n```\n\n2. Edit `config.json` with your calendar settings:\n\n```json\n{\n \"calendars\": [\n {\n \"id\": \"your-work-email@company.com\",\n \"name\": \"Work Calendar\"\n },\n {\n \"id\": \"your-personal@gmail.com\",\n \"name\": \"Personal Calendar\"\n },\n {\n \"id\": \"shared-project@company.com\",\n \"name\": \"Shared Project Calendar\"\n },\n {\n \"id\": \"student.name@university.edu\",\n \"name\": \"University Calendar\"\n }\n ],\n \"work_hours\": {\n \"start\": \"09:00\",\n \"end\": \"17:00\"\n },\n \"personal_hours\": {\n \"start\": \"08:00\",\n \"end\": \"22:00\"\n },\n \"minimum_slot_duration\": 30,\n \"default_timezone\": \"Europe/Dublin\"\n}\n```\n\n### Configuration Options\n\n- **`calendars`**: Array of calendar objects with `id` and `name` fields\n- **`work_hours`**: Define work hours (start/end times in 24-hour format)\n- **`personal_hours`**: Define personal hours (start/end times in 24-hour format)\n- **`minimum_slot_duration`**: Minimum duration in minutes for free slots to be displayed\n- **`default_timezone`**: Default timezone for date calculations (e.g., \"Europe/Dublin\", \"America/New_York\", \"UTC\")\n- **`llm`**: **(Optional)** LLM configuration for natural language processing - disabled by default\n - **`model`**: Model to use (e.g., \"ollama/llama3.3\", \"gpt-4o-mini\", \"claude-3-haiku-20240307\")\n - **`api_base`**: LLM server endpoint (varies by provider, see setup examples above)\n - **`enabled`**: Enable/disable LLM features (false by default)\n\n**\ud83d\udcdd Note**: Add as many calendars as needed - the tool will merge all busy periods to show your true availability across all calendars. This is especially useful if you have separate work, personal, and project calendars that you need to coordinate.\n\nThe `default_timezone` setting controls the timezone used for date calculations (e.g., \"today\", \"tomorrow\"). If not specified, the tool will try to use your system's timezone, falling back to UTC.\n\n## Authentication\n\nThe tool requires Google Calendar API authentication:\n\n1. Go to [Google Cloud Console](https://console.cloud.google.com/)\n2. Create a new project or select an existing one\n3. Enable the Google Calendar API\n4. Create OAuth 2.0 credentials (Desktop application)\n5. Download the credentials and save as `credentials.json` in one of these locations:\n - `~/.config/whenami/credentials.json` (recommended for system-wide access)\n - `./credentials.json` (current directory, for project-specific setup)\n\nThe first time you run the tool, it will open a browser window for authentication. The authentication token will be saved in `~/.config/whenami/token.json` for future use.\n\n## Development\n\nThis project uses GitHub Actions for CI/CD:\n\n- **CI Pipeline**: Runs tests on Python 3.9-3.12, generates coverage reports, and validates builds\n- **PyPI Publishing**: Automated publishing to PyPI on releases using trusted publishing\n\nFor development setup, see the [Local Development Setup](#local-development-setup) section above.\n",
"bugtrack_url": null,
"license": "Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n \n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n \n 1. Definitions.\n \n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n \n \"Licensor\" shall mean the copyright owner or entity granting the License.\n \n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n \n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n \n \"Source\" means the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n \n \"Object\" means any form resulting from mechanical transformation or\n translation of a Source form, including but not limited to compiled\n object code, generated documentation, and conversions to other media\n types.\n \n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (which shall not include communication that is prominently marked\n or otherwise designated in writing by the copyright owner as\n \"Not a Work\").\n \n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based upon (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and derivative works thereof.\n \n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control\n systems, and issue tracking systems that are managed by, or on behalf\n of, the Licensor for the purpose of discussing and improving the Work,\n but excluding communication that is prominently marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n \n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n \n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to use, reproduce, modify, merge, publish,\n distribute, sublicense, and/or sell copies of the Work, and to\n permit persons to whom the Work is furnished to do so, subject to\n the following conditions:\n \n The above copyright notice and this permission notice shall be\n included in all copies or substantial portions of the Work.\n \n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n \n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n \n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n \n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n \n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, trademark, patent,\n attribution and other notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n \n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n \n You may add Your own copyright notice to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n \n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n \n 6. Disclaimer of Warranty. UNLESS REQUIRED BY APPLICABLE LAW OR\n AGREED TO IN WRITING, LICENSOR PROVIDES THE WORK (AND EACH\n CONTRIBUTOR PROVIDES ITS CONTRIBUTIONS) ON AN \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR\n IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS\n OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n \n 7. Limitation of Liability. IN NO EVENT AND UNDER NO LEGAL THEORY,\n WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE,\n UNLESS REQUIRED BY APPLICABLE LAW (SUCH AS DELIBERATE AND GROSSLY\n NEGLIGENT ACTS) OR AGREED TO IN WRITING, SHALL ANY CONTRIBUTOR BE\n LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, INDIRECT, SPECIAL,\n INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER ARISING AS A\n RESULT OF THIS LICENSE OR OUT OF THE USE OR INABILITY TO USE THE\n WORK (INCLUDING BUT NOT LIMITED TO DAMAGES FOR LOSS OF GOODWILL,\n WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL\n OTHER COMMERCIAL DAMAGES OR LOSSES), EVEN IF SUCH CONTRIBUTOR\n HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.\n \n 8. Accepting Warranty or Support. You may choose to offer and charge a\n fee for, warranty, support, indemnity or other liability obligations\n and/or rights consistent with this License. However, in accepting such\n obligations, You may act only on Your own behalf and on Your sole\n responsibility, not on behalf of any other Contributor, and only if\n You agree to indemnify, defend, and hold each Contributor harmless for\n any liability incurred by, or claims asserted against, such Contributor\n by reason of your accepting any such warranty or support.\n \n END OF TERMS AND CONDITIONS\n \n APPENDIX: How to apply the Apache License to your work.\n \n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in comments for the\n particular programming language. You may also want to include a\n copyright notice such adjacent to the appropriate year(s).\n \n Copyright 2025 Lucas Zampieri\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.",
"summary": "A powerful Google Calendar tool that merges multiple calendars to find your true availability across work and personal schedules",
"version": "0.2.1",
"project_urls": {
"Changelog": "https://github.com/zampierilucas/whenami/releases",
"Homepage": "https://github.com/zampierilucas/whenami",
"Issues": "https://github.com/zampierilucas/whenami/issues",
"Repository": "https://github.com/zampierilucas/whenami"
},
"split_keywords": [
"calendar",
" google-calendar",
" productivity",
" scheduling",
" time-management"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "fd8d12d9621c168bc0b8976e0b1317c202bbf1a8241df917501eafd00d34d9e2",
"md5": "185295f4ab4e6a22f92efb7b28d5e937",
"sha256": "67f2a6f9a1fa21465d9b2068400682d64e0bbd17bba9b2adf5a64e0374af33e5"
},
"downloads": -1,
"filename": "whenami-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "185295f4ab4e6a22f92efb7b28d5e937",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 33626,
"upload_time": "2025-07-17T13:30:43",
"upload_time_iso_8601": "2025-07-17T13:30:43.672842Z",
"url": "https://files.pythonhosted.org/packages/fd/8d/12d9621c168bc0b8976e0b1317c202bbf1a8241df917501eafd00d34d9e2/whenami-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "558ced390006dedc45f6221ee482ef2916ea269e314910a0ae639457b871f907",
"md5": "2c01b180b1c82cc05c5ebfc3509e3bd4",
"sha256": "cda3a5b7771ae96791c6d18cf2f8d1d9c6d8e281db68e14bbe6bc927cabe2d57"
},
"downloads": -1,
"filename": "whenami-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "2c01b180b1c82cc05c5ebfc3509e3bd4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 646100,
"upload_time": "2025-07-17T13:30:45",
"upload_time_iso_8601": "2025-07-17T13:30:45.229624Z",
"url": "https://files.pythonhosted.org/packages/55/8c/ed390006dedc45f6221ee482ef2916ea269e314910a0ae639457b871f907/whenami-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-17 13:30:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zampierilucas",
"github_project": "whenami",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "whenami"
}
