timetree-exporter 0.1.0__tar.gz

timetree-exporter-0.1.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

timetree-exporter-0.1.0/.github/workflows/pylint.yml

@@ -0,0 +1,24 @@
+name: Pylint
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pylint
+        python -m pip install -r requirements.txt
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files '*.py')

timetree-exporter-0.1.0/.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

timetree-exporter-0.1.0/.github/workflows/release-please.yml

@@ -0,0 +1,19 @@
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+name: release-please
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v4
+        with:
+          token: ${{ secrets.MY_RELEASE_PLEASE_TOKEN }}
+          release-type: python

timetree-exporter-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+responses/sync*
+timetree.ics
+.venv
+.DS_Store
+*.pyc
+dist
+*.egg-info

timetree-exporter-0.1.0/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "editor.defaultFormatter": "ms-python.black-formatter",
+    "editor.formatOnSave": true
+}

timetree-exporter-0.1.0/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+## 0.1.0 (2024-04-06)
+
+
+### Features
+
+* argparse ([#12](https://github.com/eoleedi/TimeTree-exporter/issues/12)) ([1eae588](https://github.com/eoleedi/TimeTree-exporter/commit/1eae588f96e462dc12f9c5998c88b5582c25e0d5))
+* created & last-modify ([fab8d76](https://github.com/eoleedi/TimeTree-exporter/commit/fab8d76c380c175cc4b7e8cba6fbc740bafe31f6))
+* first commit - basic title, time, and alert function ([bac0eca](https://github.com/eoleedi/TimeTree-exporter/commit/bac0ecab5f9d778f9e5113c988cbbcf024367600))
+* geo (location lat & lon) ([3547100](https://github.com/eoleedi/TimeTree-exporter/commit/3547100430ab817aea98937e6e8ab4e3cc33fea3))
+* note and url ([61adb88](https://github.com/eoleedi/TimeTree-exporter/commit/61adb887f35d1d456b610a6ac19bcf35b5b96438))
+* recurrences ([5c37911](https://github.com/eoleedi/TimeTree-exporter/commit/5c37911b584ba022f2114340612ee5572d8ec265))
+
+
+### Bug Fixes
+
+* full day event & timezone issue ([41467ab](https://github.com/eoleedi/TimeTree-exporter/commit/41467ab0942c8a5ded425bbe73ca44de62481d56))
+* write to file after parsing all the files ([bc0fd7f](https://github.com/eoleedi/TimeTree-exporter/commit/bc0fd7f20c12410cf2e548b4c419f89a775a5845))
+
+
+### Documentation
+
+* add detailed description & remove the API limitation ([edeea3a](https://github.com/eoleedi/TimeTree-exporter/commit/edeea3aacfa64acaf5479912350c219941845702))
+* add detailed instructions and info ([70c1e89](https://github.com/eoleedi/TimeTree-exporter/commit/70c1e89ec8a6b7172919f02c37ca54964953f911))
+* add newline ([cc5275a](https://github.com/eoleedi/TimeTree-exporter/commit/cc5275a33a01bf1c67db22ed01b5e7402fcf17c2))
+* add recommendation and remove in-development warning ([776d5f2](https://github.com/eoleedi/TimeTree-exporter/commit/776d5f271b8127c724f8d3be03e54e1ab41e52b1))
+* bump icalendar from 5.0.11 to 5.0.12 ([a934c7b](https://github.com/eoleedi/TimeTree-exporter/commit/a934c7bdc53b8206ef7e37af7af3a0585a5d0abc))
+* finish all day ([e23021e](https://github.com/eoleedi/TimeTree-exporter/commit/e23021e24cc9f038bdc070eea530f331bb3e1fde))
+* fix typo ([248b669](https://github.com/eoleedi/TimeTree-exporter/commit/248b669c7027f37035778385d38902ec569ddf70))
+* update document for pip installation method ([83cfaea](https://github.com/eoleedi/TimeTree-exporter/commit/83cfaea4ec55ad38836e9cd7c11896343b1915f9))
+* use absolute path for images ([0bf9e33](https://github.com/eoleedi/TimeTree-exporter/commit/0bf9e33da0e2afe8ae84b085e07357b47ade1080))

timetree-exporter-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 蔡鳳駿
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software 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 Software.
+
+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.

timetree-exporter-0.1.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.1
+Name: timetree-exporter
+Version: 0.1.0
+Summary: A Tool for Exporting TimeTree Calendar and Convert to iCal format(.ics)
+Author-email: Fong-Chun Tsai <eoleedimin@gmail.com>
+Project-URL: Homepage, https://github.com/eoleedi/TimeTree-Exporter
+Project-URL: Repository, https://github.com/eoleedi/TimeTree-Exporter
+Project-URL: Issues, https://github.com/eoleedi/TimeTree-Exporter/issues
+Project-URL: Changelog, https://github.com/eoleedi/TimeTree-Exporter/CHANGELOG.md
+Keywords: timetree,exporter,icalendar,ics
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: icalendar
+
+# TimeTree Exporter
+A Tool for Exporting TimeTree Calendar and Convert to iCal format(.ics) \
+(The .ics file can then be imported into other calendar apps such as Google Calendar, Apple Calendar, Outlook Calendar, etc.)
+
+# Usage
+
+First, download the timetree data manually and put it in the responses folder(see below)
+
+## Method 1: Pip
+1. Install the package `pip3 install timetree-exporter`
+2. Run `timetree-exporter <path-to-responses-folder>`
+3. A timetree.ics file will be generated in the same directory, then you can import it to your calendar app.
+
+## Method 2: Cloning the repository
+1. Clone the repository `git clone https://github.com/eoleedi/TimeTree-exporter.git`
+2. Change the directory to the project folder `cd TimeTree-exporter`
+3. Install the requirements `pip3 install -r requirements.txt`
+4. Run `python3 -m timetree_exporter responses`
+5. A timetree.ics file will be generated in the same directory, then you can import it to your calendar app.
+   
+## How to download timetree data
+1. Go to [https://timetreeapp.com/signin](https://timetreeapp.com/signin)
+2. Open the developer tools before logging in
+      > Can be opened by pressing F12
+3. Go to the network tab
+      > Remember to Press Ctrl + R to start recording
+4. Turn on preserve log
+5. Type in "sync" in the filter box
+6. Log in
+7. Click on the calendar you want to export
+8. You will see couple of requests with the name "sync"
+      > There seems to be a maximum of 300 events in single requests. \
+      > If you have more than 300 events, you will see multiple requests with the name "sync"
+9.  Right click on the request and select "Copy Response"
+10. Paste it into a json file under the response folder under this project (etc. sync.json)
+      > The file name should end with .json
+11. Do the same thing for all the requests with steps 7~10
+
+![Prepare for signin: Step 1~5](https://github.com/eoleedi/TimeTree-exporter/raw/main/assets/images/prepare-for-signin.png)
+*Prepare for signin: Step 1~5*
+![Copy response: Step 8~9](https://github.com/eoleedi/TimeTree-exporter/raw/main/assets/images/copy-response.png)
+*Copy response: Step 8~9*
+
+# Advanced Usage
+You can also specify the output file name by running `python3 -m timetree_exporter -o <output_file_name>.ics` or `timetree-exporter -o <output_file_name>.ics`
+
+# Recommendation
+You are recommended to import the ics file into a separate calendar (take google calendar as an example) as if anything goes wrong, you can just delete the calendar and reimport it.
+
+# Requirements
+icalendar==5.0.12
+
+# Limitations
+Currently, TimeTree data can only be downloaded manually through a web browser.
+
+# Roadmap of the properties mapping to iCal
+- [ ] **ID**
+- [ ] **Primary ID**
+- [ ] **Calendar ID**
+- [x] **UUID**
+- [ ] **Category**
+- [ ] **Type**
+- [ ] **Author ID**
+- [ ] **Author Type**
+- [x] **Title**
+- [x] **All Day**
+- [x] **Start At**
+- [x] **Start Timezone**
+- [x] **End At**
+- [x] **End Timezone**
+- [ ] **Label ID**
+- [x] **Location**
+- [x] **Location Latitude**
+- [x] **Location Longitude**
+- [x] **URL**
+- [x] **Note**
+- [ ] **Lunar**
+- [ ] **Attendees**
+- [x] **Recurrences**
+- [ ] **Recurring UUID**
+- [x] **Alerts**
+- [ ] **Parent ID**
+- [ ] **Link Object ID**
+- [ ] **Link Object ID String**
+- [ ] **Row Order**
+- [ ] **Attachment**
+- [ ] **Like Count**
+- [ ] **Files**
+- [ ] **Deactivated At**
+- [ ] **Pinned At**
+- [x] **Updated At**
+- [x] **Created At**

timetree-exporter-0.1.0/README.md

@@ -0,0 +1,92 @@
+# TimeTree Exporter
+A Tool for Exporting TimeTree Calendar and Convert to iCal format(.ics) \
+(The .ics file can then be imported into other calendar apps such as Google Calendar, Apple Calendar, Outlook Calendar, etc.)
+
+# Usage
+
+First, download the timetree data manually and put it in the responses folder(see below)
+
+## Method 1: Pip
+1. Install the package `pip3 install timetree-exporter`
+2. Run `timetree-exporter <path-to-responses-folder>`
+3. A timetree.ics file will be generated in the same directory, then you can import it to your calendar app.
+
+## Method 2: Cloning the repository
+1. Clone the repository `git clone https://github.com/eoleedi/TimeTree-exporter.git`
+2. Change the directory to the project folder `cd TimeTree-exporter`
+3. Install the requirements `pip3 install -r requirements.txt`
+4. Run `python3 -m timetree_exporter responses`
+5. A timetree.ics file will be generated in the same directory, then you can import it to your calendar app.
+   
+## How to download timetree data
+1. Go to [https://timetreeapp.com/signin](https://timetreeapp.com/signin)
+2. Open the developer tools before logging in
+      > Can be opened by pressing F12
+3. Go to the network tab
+      > Remember to Press Ctrl + R to start recording
+4. Turn on preserve log
+5. Type in "sync" in the filter box
+6. Log in
+7. Click on the calendar you want to export
+8. You will see couple of requests with the name "sync"
+      > There seems to be a maximum of 300 events in single requests. \
+      > If you have more than 300 events, you will see multiple requests with the name "sync"
+9.  Right click on the request and select "Copy Response"
+10. Paste it into a json file under the response folder under this project (etc. sync.json)
+      > The file name should end with .json
+11. Do the same thing for all the requests with steps 7~10
+
+![Prepare for signin: Step 1~5](https://github.com/eoleedi/TimeTree-exporter/raw/main/assets/images/prepare-for-signin.png)
+*Prepare for signin: Step 1~5*
+![Copy response: Step 8~9](https://github.com/eoleedi/TimeTree-exporter/raw/main/assets/images/copy-response.png)
+*Copy response: Step 8~9*
+
+# Advanced Usage
+You can also specify the output file name by running `python3 -m timetree_exporter -o <output_file_name>.ics` or `timetree-exporter -o <output_file_name>.ics`
+
+# Recommendation
+You are recommended to import the ics file into a separate calendar (take google calendar as an example) as if anything goes wrong, you can just delete the calendar and reimport it.
+
+# Requirements
+icalendar==5.0.12
+
+# Limitations
+Currently, TimeTree data can only be downloaded manually through a web browser.
+
+# Roadmap of the properties mapping to iCal
+- [ ] **ID**
+- [ ] **Primary ID**
+- [ ] **Calendar ID**
+- [x] **UUID**
+- [ ] **Category**
+- [ ] **Type**
+- [ ] **Author ID**
+- [ ] **Author Type**
+- [x] **Title**
+- [x] **All Day**
+- [x] **Start At**
+- [x] **Start Timezone**
+- [x] **End At**
+- [x] **End Timezone**
+- [ ] **Label ID**
+- [x] **Location**
+- [x] **Location Latitude**
+- [x] **Location Longitude**
+- [x] **URL**
+- [x] **Note**
+- [ ] **Lunar**
+- [ ] **Attendees**
+- [x] **Recurrences**
+- [ ] **Recurring UUID**
+- [x] **Alerts**
+- [ ] **Parent ID**
+- [ ] **Link Object ID**
+- [ ] **Link Object ID String**
+- [ ] **Row Order**
+- [ ] **Attachment**
+- [ ] **Like Count**
+- [ ] **Files**
+- [ ] **Deactivated At**
+- [ ] **Pinned At**
+- [x] **Updated At**
+- [x] **Created At**

timetree-exporter-0.1.0/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["setuptools", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+include = ["timetree_exporter"]
+
+[project]
+name = "timetree-exporter"
+dynamic = ["version"]
+authors = [
+  { name="Fong-Chun Tsai", email="eoleedimin@gmail.com" },
+]
+description = "A Tool for Exporting TimeTree Calendar and Convert to iCal format(.ics)"
+keywords = ["timetree", "exporter", "icalendar", "ics"]
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "icalendar",
+]
+
+[project.urls]
+Homepage = "https://github.com/eoleedi/TimeTree-Exporter"
+Repository = "https://github.com/eoleedi/TimeTree-Exporter"
+Issues = "https://github.com/eoleedi/TimeTree-Exporter/issues"
+Changelog = "https://github.com/eoleedi/TimeTree-Exporter/CHANGELOG.md"
+
+[project.scripts]
+timetree-exporter = "timetree_exporter.__main__:main"
+
+[tool.setuptools_scm]

timetree-exporter-0.1.0/requirements.txt

@@ -0,0 +1 @@
+icalendar==5.0.12

timetree-exporter-0.1.0/responses/README.md

@@ -0,0 +1,49 @@
+# This is the folder to put the json responses from timetree
+## Here is an exmaple format of the response
+```json
+{
+    "since": null,
+    "chunk": null,
+    "events": [
+        {
+            "id": null,
+            "primary_id": null,
+            "calendar_id": null,
+            "uuid": null,
+            "category": null,
+            "type": null,
+            "author_id": null,
+            "author_type": null,
+            "title": null,
+            "all_day": null,
+            "start_at": null,
+            "start_timezone": null,
+            "end_at": null,
+            "end_timezone": null,
+            "label_id": null,
+            "location": null,
+            "location_lat": null,
+            "location_lon": null,
+            "url": null,
+            "note": null,
+            "lunar": null,
+            "attendees": [],
+            "recurrences": [],
+            "recurring_uuid": null,
+            "alerts": [],
+            "parent_id": null,
+            "link_object_id": null,
+            "link_object_id_string": null,
+            "row_order": null,
+            "attachment": {},
+            "like_count": null,
+            "files": [],
+            "deactivated_at": null,
+            "pinned_at": null,
+            "updated_at": null,
+            "created_at": null
+        },
+        ... more events
+    ]
+}
+```

timetree-exporter-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

timetree-exporter-0.1.0/timetree_exporter/__init__.py

@@ -0,0 +1,4 @@
+"""Init file for timetree_exporter package."""
+
+from timetree_exporter.event import TimeTreeEvent
+from timetree_exporter.formatter import ICalEventFormatter

timetree-exporter-0.1.0/timetree_exporter/__main__.py

@@ -0,0 +1,57 @@
+"""
+This module converts Timetree events to iCal format.
+It is intended to be used with the Timetree API response files.
+https://timetreeapp.com/api/v1/calendar/{calendar_id}/events/sync
+"""
+
+import argparse
+from icalendar import Calendar
+from timetree_exporter import TimeTreeEvent, ICalEventFormatter
+from timetree_exporter.utils import get_events_from_file, paths_to_filelist
+
+# Parse arguments
+parser = argparse.ArgumentParser(
+    description="Convert Timetree events to iCal format",
+    prog="timetree_exporter",
+)
+parser.add_argument(
+    "input",
+    type=str,
+    help="Path to the Timetree response file(s)/folder",
+    nargs="+",
+)
+parser.add_argument(
+    "-o",
+    "--output",
+    type=str,
+    help="Path to the output iCal file",
+    default="timetree.ics",
+)
+args = parser.parse_args()
+
+
+cal = Calendar()
+filenames = paths_to_filelist(args.input)
+
+for filename in filenames:
+    # Skip non-JSON files
+    if not filename.endswith(".json"):
+        print(f"Skipping {filename} (Invalid file type, should be .json)")
+        continue
+    print(f"Parsing {filename}")
+
+    # Get events from file
+    events = get_events_from_file(filename)
+    if events is None:
+        continue
+
+    # Add events to calendar
+    for event in events:
+        time_tree_event = TimeTreeEvent.from_dict(event)
+        formatter = ICalEventFormatter(time_tree_event)
+        iCalEvent = formatter.to_ical()
+        cal.add_component(iCalEvent)
+
+# Write calendar to file
+with open(args.output, "wb") as f:  # Path Traversal Vulnerability if on a server
+    f.write(cal.to_ical())

timetree-exporter-0.1.0/timetree_exporter/event.py

@@ -0,0 +1,70 @@
+"""This module provides the TimeTreeEvent class for representing TimeTree events."""
+
+
+class TimeTreeEvent:
+    """TimeTree event class"""
+
+    # pylint: disable=too-many-instance-attributes
+
+    def __init__(
+        self,
+        uuid: str,
+        title: str,
+        created_at: int,
+        updated_at: int,
+        recurrences: list,
+        alerts: list,
+        url: str,
+        note: str,
+        start_at: int,
+        end_at: int,
+        all_day: bool,
+        start_timezone: str,
+        end_timezone: str,
+        location_lat: str,
+        location_lon: str,
+        location: str,
+    ):
+        # pylint: disable=too-many-arguments
+        # pylint: disable=too-many-locals
+        self.uuid = uuid
+        self.title = title
+        self.created_at = created_at
+        self.updated_at = updated_at
+        self.note = note
+        self.location = location
+        self.location_lat = location_lat
+        self.location_lon = location_lon
+        self.url = url
+        self.start_at = start_at
+        self.start_timezone = start_timezone
+        self.end_at = end_at
+        self.end_timezone = end_timezone
+        self.all_day = all_day
+        self.alerts = alerts
+        self.recurrences = recurrences
+
+    @classmethod
+    def from_dict(cls, event_data: dict):
+        """Create TimeTreeEvent object from JSON data"""
+        return cls(
+            uuid=event_data.get("uuid"),
+            title=event_data.get("title"),
+            created_at=event_data.get("created_at"),
+            updated_at=event_data.get("updated_at"),
+            note=event_data.get("note"),
+            location=event_data.get("location"),
+            location_lat=event_data.get("location_lat"),
+            location_lon=event_data.get("location_lon"),
+            url=event_data.get("url"),
+            start_at=event_data.get("start_at"),
+            start_timezone=event_data.get("start_timezone"),
+            end_at=event_data.get("end_at"),
+            end_timezone=event_data.get("end_timezone"),
+            all_day=event_data.get("all_day"),
+            alerts=event_data.get("alerts"),
+            recurrences=event_data.get("recurrences"),
+        )
+
+    def __str__(self):
+        return self.title

timetree-exporter-0.1.0/timetree_exporter/formatter.py

@@ -0,0 +1,164 @@
+"""
+This module provides the ICalEventFormatter class 
+for formatting TimeTree events into iCalendar format.
+"""
+
+from datetime import datetime, timedelta
+from icalendar import Event, vRecur, vDate, vDatetime, vGeo
+from icalendar.prop import vDDDLists
+from icalendar.parser import Contentline
+from dateutil import tz
+from timetree_exporter.event import TimeTreeEvent
+
+
+class ICalEventFormatter:
+    """
+    Class for formatting TimeTree events into iCalendar format.
+    """
+
+    def __init__(self, time_tree_event: TimeTreeEvent):
+        self.time_tree_event = time_tree_event
+
+    @property
+    def uid(self):
+        """Return the UUID of the event."""
+        return self.time_tree_event.uuid
+
+    @property
+    def summary(self):
+        """Return the title of the event."""
+        return self.time_tree_event.title
+
+    @property
+    def created(self):
+        """Return the creation time of the event."""
+        return vDatetime(
+            datetime.fromtimestamp(
+                self.time_tree_event.created_at / 1000, tz.gettz("UTC")
+            )
+        )
+
+    @property
+    def last_modify(self):
+        """Return the last modification time of the event."""
+        return vDatetime(
+            datetime.fromtimestamp(
+                self.time_tree_event.updated_at / 1000, tz.gettz("UTC")
+            )
+        )
+
+    @property
+    def description(self):
+        """Return the note of the event."""
+        return self.time_tree_event.note if self.time_tree_event.note != "" else None
+
+    @property
+    def location(self):
+        """Return the location of the event."""
+        return (
+            self.time_tree_event.location
+            if self.time_tree_event.location != ""
+            else None
+        )
+
+    @property
+    def geo(self):
+        """Return the geolocation of the event."""
+        if (
+            self.time_tree_event.location_lat is None
+            or self.time_tree_event.location_lon is None
+        ):
+            return None
+        return vGeo(
+            (self.time_tree_event.location_lat, self.time_tree_event.location_lon)
+        )
+
+    @property
+    def url(self):
+        """Return the URL of the event."""
+        return self.time_tree_event.url if self.time_tree_event.url != "" else None
+
+    def get_datetime(self, is_start_time):
+        """Return the start or end time of the event."""
+        if is_start_time:
+            time = self.time_tree_event.start_at
+            timezone = self.time_tree_event.start_timezone
+        else:
+            time = self.time_tree_event.end_at
+            timezone = self.time_tree_event.end_timezone
+
+        if self.time_tree_event.all_day:
+            return vDate(
+                datetime.fromtimestamp(
+                    time / 1000,
+                    tz.gettz(timezone),
+                )
+            )
+        return vDatetime(
+            datetime.fromtimestamp(
+                time / 1000,
+                tz.gettz(timezone),
+            )
+        )
+
+    @property
+    def dtstart(self):
+        """Return the start time of the event."""
+        return self.get_datetime(is_start_time=True)
+
+    @property
+    def dtend(self):
+        """Return the end time of the event."""
+        return self.get_datetime(is_start_time=False)
+
+    @property
+    def alerts(self):
+        """Return the alerts of the event."""
+        alerts = []
+        for alert in self.time_tree_event.alerts:
+            alarm = Event()
+            alarm.add("action", "DISPLAY")
+            alarm.add("description", "Reminder")
+            alarm.add("trigger", timedelta(minutes=-alert))
+            alerts.append(alarm)
+        return alerts
+
+    def add_recurrences(self, event):
+        """Add recurrences to iCal event"""
+        for recurrence in self.time_tree_event.recurrences:
+            contentline = Contentline(recurrence)
+            name, parameters, value = contentline.parts()
+            if name.lower() == "rrule":
+                event.add(name, vRecur.from_ical(value), parameters)
+            elif name.lower() == "exdate" or name.lower() == "rdate":
+                event.add(name, vDDDLists.from_ical(value), parameters)
+            else:
+                raise ValueError(f"Unknown recurrence type: {name}")
+
+    def to_ical(self) -> Event:
+        """Return the iCal event."""
+        event = Event()
+
+        event.add("uid", self.uid)
+        event.add("summary", self.summary)
+        event.add("dtstamp", datetime.now(tz.tzutc()))
+        event.add("created", self.created)
+        event.add("last-modify", self.last_modify)
+        event.add("dtstart", self.dtstart)
+        event.add("dtend", self.dtend)
+
+        if self.location:
+            event.add("location", self.location)
+        if self.geo:
+            event.add("geo", self.geo)
+        if self.url:
+            event.add("url", self.url)
+        if self.description:
+            event.add("description", self.description)
+
+        for alert in self.alerts:
+            event.add_component(alert)
+
+        self.add_recurrences(event)
+
+        return event

timetree-exporter-0.1.0/timetree_exporter/utils.py

@@ -0,0 +1,28 @@
+"""Utility functions for Timetree Exporter"""
+
+import json
+import os
+
+
+def get_events_from_file(file_path) -> list:
+    """Fetch events from Timetree response file"""
+    try:
+        with open(file_path, "r", encoding="UTF-8") as response_file:
+            response_data = json.load(response_file)
+            return response_data["events"]
+    except FileNotFoundError:
+        print(f"File not found: {file_path}")
+        return None
+
+
+def paths_to_filelist(paths: list) -> list:
+    """Converts a list of paths to a list of files"""
+    filenames = []
+    for path in paths:
+        if os.path.isdir(path):
+            filenames += [os.path.join(path, file) for file in os.listdir(path)]
+        elif os.path.isfile(path):
+            filenames.append(path)
+        else:
+            print(f"Invalid path: {path}")
+    return filenames

timetree-exporter-0.1.0/timetree_exporter.egg-info/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.1
+Name: timetree-exporter
+Version: 0.1.0
+Summary: A Tool for Exporting TimeTree Calendar and Convert to iCal format(.ics)
+Author-email: Fong-Chun Tsai <eoleedimin@gmail.com>
+Project-URL: Homepage, https://github.com/eoleedi/TimeTree-Exporter
+Project-URL: Repository, https://github.com/eoleedi/TimeTree-Exporter
+Project-URL: Issues, https://github.com/eoleedi/TimeTree-Exporter/issues
+Project-URL: Changelog, https://github.com/eoleedi/TimeTree-Exporter/CHANGELOG.md
+Keywords: timetree,exporter,icalendar,ics
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: icalendar
+
+# TimeTree Exporter
+A Tool for Exporting TimeTree Calendar and Convert to iCal format(.ics) \
+(The .ics file can then be imported into other calendar apps such as Google Calendar, Apple Calendar, Outlook Calendar, etc.)
+
+# Usage
+
+First, download the timetree data manually and put it in the responses folder(see below)
+
+## Method 1: Pip
+1. Install the package `pip3 install timetree-exporter`
+2. Run `timetree-exporter <path-to-responses-folder>`
+3. A timetree.ics file will be generated in the same directory, then you can import it to your calendar app.
+
+## Method 2: Cloning the repository
+1. Clone the repository `git clone https://github.com/eoleedi/TimeTree-exporter.git`
+2. Change the directory to the project folder `cd TimeTree-exporter`
+3. Install the requirements `pip3 install -r requirements.txt`
+4. Run `python3 -m timetree_exporter responses`
+5. A timetree.ics file will be generated in the same directory, then you can import it to your calendar app.
+   
+## How to download timetree data
+1. Go to [https://timetreeapp.com/signin](https://timetreeapp.com/signin)
+2. Open the developer tools before logging in
+      > Can be opened by pressing F12
+3. Go to the network tab
+      > Remember to Press Ctrl + R to start recording
+4. Turn on preserve log
+5. Type in "sync" in the filter box
+6. Log in
+7. Click on the calendar you want to export
+8. You will see couple of requests with the name "sync"
+      > There seems to be a maximum of 300 events in single requests. \
+      > If you have more than 300 events, you will see multiple requests with the name "sync"
+9.  Right click on the request and select "Copy Response"
+10. Paste it into a json file under the response folder under this project (etc. sync.json)
+      > The file name should end with .json
+11. Do the same thing for all the requests with steps 7~10
+
+![Prepare for signin: Step 1~5](https://github.com/eoleedi/TimeTree-exporter/raw/main/assets/images/prepare-for-signin.png)
+*Prepare for signin: Step 1~5*
+![Copy response: Step 8~9](https://github.com/eoleedi/TimeTree-exporter/raw/main/assets/images/copy-response.png)
+*Copy response: Step 8~9*
+
+# Advanced Usage
+You can also specify the output file name by running `python3 -m timetree_exporter -o <output_file_name>.ics` or `timetree-exporter -o <output_file_name>.ics`
+
+# Recommendation
+You are recommended to import the ics file into a separate calendar (take google calendar as an example) as if anything goes wrong, you can just delete the calendar and reimport it.
+
+# Requirements
+icalendar==5.0.12
+
+# Limitations
+Currently, TimeTree data can only be downloaded manually through a web browser.
+
+# Roadmap of the properties mapping to iCal
+- [ ] **ID**
+- [ ] **Primary ID**
+- [ ] **Calendar ID**
+- [x] **UUID**
+- [ ] **Category**
+- [ ] **Type**
+- [ ] **Author ID**
+- [ ] **Author Type**
+- [x] **Title**
+- [x] **All Day**
+- [x] **Start At**
+- [x] **Start Timezone**
+- [x] **End At**
+- [x] **End Timezone**
+- [ ] **Label ID**
+- [x] **Location**
+- [x] **Location Latitude**
+- [x] **Location Longitude**
+- [x] **URL**
+- [x] **Note**
+- [ ] **Lunar**
+- [ ] **Attendees**
+- [x] **Recurrences**
+- [ ] **Recurring UUID**
+- [x] **Alerts**
+- [ ] **Parent ID**
+- [ ] **Link Object ID**
+- [ ] **Link Object ID String**
+- [ ] **Row Order**
+- [ ] **Attachment**
+- [ ] **Like Count**
+- [ ] **Files**
+- [ ] **Deactivated At**
+- [ ] **Pinned At**
+- [x] **Updated At**
+- [x] **Created At**

timetree-exporter-0.1.0/timetree_exporter.egg-info/SOURCES.txt

@@ -0,0 +1,25 @@
+.gitignore
+CHANGELOG.md
+LICENSE
+README.md
+pyproject.toml
+requirements.txt
+.github/dependabot.yml
+.github/workflows/pylint.yml
+.github/workflows/python-publish.yml
+.github/workflows/release-please.yml
+.vscode/settings.json
+assets/images/copy-response.png
+assets/images/prepare-for-signin.png
+responses/README.md
+timetree_exporter/__init__.py
+timetree_exporter/__main__.py
+timetree_exporter/event.py
+timetree_exporter/formatter.py
+timetree_exporter/utils.py
+timetree_exporter.egg-info/PKG-INFO
+timetree_exporter.egg-info/SOURCES.txt
+timetree_exporter.egg-info/dependency_links.txt
+timetree_exporter.egg-info/entry_points.txt
+timetree_exporter.egg-info/requires.txt
+timetree_exporter.egg-info/top_level.txt

timetree-exporter-0.1.0/timetree_exporter.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

timetree-exporter-0.1.0/timetree_exporter.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+timetree-exporter = timetree_exporter.__main__:main

timetree-exporter-0.1.0/timetree_exporter.egg-info/requires.txt

@@ -0,0 +1 @@
+icalendar

timetree-exporter-0.1.0/timetree_exporter.egg-info/top_level.txt

@@ -0,0 +1 @@
+timetree_exporter