timetree-exporter


Nametimetree-exporter JSON
Version 0.3.0 PyPI version JSON
download
home_pageNone
SummaryA Tool for Exporting TimeTree Calendar and Convert to iCal format(.ics)
upload_time2024-04-20 15:28:58
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords timetree exporter icalendar ics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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/docs/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/docs/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**
- [x] **Category**
- [x] **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**
- [x] **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**

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "timetree-exporter",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "timetree, exporter, icalendar, ics",
    "author": null,
    "author_email": "Fong-Chun Tsai <eoleedimin@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/f5/7b/4748f1c67821cf9b948d407986c4d794a6c73a70e74b18fc4b564d37a616/timetree_exporter-0.3.0.tar.gz",
    "platform": null,
    "description": "# TimeTree Exporter\nA Tool for Exporting TimeTree Calendar and Convert to iCal format(.ics) \\\n(The .ics file can then be imported into other calendar apps such as Google Calendar, Apple Calendar, Outlook Calendar, etc.)\n\n# Usage\n\nFirst, download the timetree data manually and put it in the responses folder(see below)\n\n## Method 1: Pip\n1. Install the package `pip3 install timetree-exporter`\n2. Run `timetree-exporter <path-to-responses-folder>`\n3. A timetree.ics file will be generated in the same directory, then you can import it to your calendar app.\n\n## Method 2: Cloning the repository\n1. Clone the repository `git clone https://github.com/eoleedi/TimeTree-exporter.git`\n2. Change the directory to the project folder `cd TimeTree-exporter`\n3. Install the requirements `pip3 install -r requirements.txt`\n4. Run `python3 -m timetree_exporter responses`\n5. A timetree.ics file will be generated in the same directory, then you can import it to your calendar app.\n   \n## How to download timetree data\n1. Go to [https://timetreeapp.com/signin](https://timetreeapp.com/signin)\n2. Open the developer tools before logging in\n      > Can be opened by pressing F12\n3. Go to the network tab\n      > Remember to Press Ctrl + R to start recording\n4. Turn on preserve log\n5. Type in \"sync\" in the filter box\n6. Log in\n7. Click on the calendar you want to export\n8. You will see couple of requests with the name \"sync\"\n      > There seems to be a maximum of 300 events in single requests. \\\n      > If you have more than 300 events, you will see multiple requests with the name \"sync\"\n9.  Right click on the request and select \"Copy Response\"\n10. Paste it into a json file under the response folder under this project (etc. sync.json)\n      > The file name should end with .json\n11. Do the same thing for all the requests with steps 7~10\n\n![Prepare for signin: Step 1~5](https://github.com/eoleedi/TimeTree-exporter/raw/main/docs/assets/images/prepare-for-signin.png)\n*Prepare for signin: Step 1~5*\n![Copy response: Step 8~9](https://github.com/eoleedi/TimeTree-exporter/raw/main/docs/assets/images/copy-response.png)\n*Copy response: Step 8~9*\n\n# Advanced Usage\nYou 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`\n\n# Recommendation\nYou 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.\n\n# Requirements\nicalendar==5.0.12\n\n# Limitations\nCurrently, TimeTree data can only be downloaded manually through a web browser.\n\n# Roadmap of the properties mapping to iCal\n- [ ] **ID**\n- [ ] **Primary ID**\n- [ ] **Calendar ID**\n- [x] **UUID**\n- [x] **Category**\n- [x] **Type**\n- [ ] **Author ID**\n- [ ] **Author Type**\n- [x] **Title**\n- [x] **All Day**\n- [x] **Start At**\n- [x] **Start Timezone**\n- [x] **End At**\n- [x] **End Timezone**\n- [ ] **Label ID**\n- [x] **Location**\n- [x] **Location Latitude**\n- [x] **Location Longitude**\n- [x] **URL**\n- [x] **Note**\n- [ ] **Lunar**\n- [ ] **Attendees**\n- [x] **Recurrences**\n- [ ] **Recurring UUID**\n- [x] **Alerts**\n- [x] **Parent ID**\n- [ ] **Link Object ID**\n- [ ] **Link Object ID String**\n- [ ] **Row Order**\n- [ ] **Attachment**\n- [ ] **Like Count**\n- [ ] **Files**\n- [ ] **Deactivated At**\n- [ ] **Pinned At**\n- [x] **Updated At**\n- [x] **Created At**\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Tool for Exporting TimeTree Calendar and Convert to iCal format(.ics)",
    "version": "0.3.0",
    "project_urls": {
        "Changelog": "https://github.com/eoleedi/TimeTree-exporter/blob/main/CHANGELOG.md",
        "Homepage": "https://github.com/eoleedi/TimeTree-Exporter",
        "Issues": "https://github.com/eoleedi/TimeTree-Exporter/issues",
        "Repository": "https://github.com/eoleedi/TimeTree-Exporter"
    },
    "split_keywords": [
        "timetree",
        " exporter",
        " icalendar",
        " ics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "095c926899199f031df4d3aee149c25df0b2bbbc990b4ae0da3dd8acf50ce1f9",
                "md5": "79a2ea73b5e5c885b791dc2216929817",
                "sha256": "4bcc10a96f14b71dfb0927155daeb6ddcf774336390bad70d6004b8d5893a7ec"
            },
            "downloads": -1,
            "filename": "timetree_exporter-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "79a2ea73b5e5c885b791dc2216929817",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 8724,
            "upload_time": "2024-04-20T15:28:57",
            "upload_time_iso_8601": "2024-04-20T15:28:57.282682Z",
            "url": "https://files.pythonhosted.org/packages/09/5c/926899199f031df4d3aee149c25df0b2bbbc990b4ae0da3dd8acf50ce1f9/timetree_exporter-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f57b4748f1c67821cf9b948d407986c4d794a6c73a70e74b18fc4b564d37a616",
                "md5": "556a61b28d35629dfaf6351005812b44",
                "sha256": "0bb90ddcbb983d0fc9fe1daa73216567c398491063008ff12bc6f8fb4eef0b28"
            },
            "downloads": -1,
            "filename": "timetree_exporter-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "556a61b28d35629dfaf6351005812b44",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 688615,
            "upload_time": "2024-04-20T15:28:58",
            "upload_time_iso_8601": "2024-04-20T15:28:58.510615Z",
            "url": "https://files.pythonhosted.org/packages/f5/7b/4748f1c67821cf9b948d407986c4d794a6c73a70e74b18fc4b564d37a616/timetree_exporter-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-20 15:28:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "eoleedi",
    "github_project": "TimeTree-exporter",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "timetree-exporter"
}
        
Elapsed time: 0.22808s