| Name | tolino-notes JSON |
| Version |
0.3.2
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-12-28 09:45:49 |
| maintainer | Basti Tee |
| docs_url | None |
| author | Basti Tee |
| requires_python | <4.0.0,>=3.9.0 |
| license | Apache 2.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Tolino Notes
> Convert Tolino notes into useful formats
Tolino stores your highlights and notes in a `notes.txt` file on your device. However that file has a strange structure and mixes books when you read multiple ones at a time. And the content depends on the language-setting of your device.
This project tries to close the gap by doing the heavy-lifting of parsing the file, sorting and converting to a commonly used format such as Markdown or JSON. – one file per book found in your `notes.txt`.
Where do I find this file?
- Connect your Tolino to your computer via USB.
- Use a file manager (Explorer, Finder, etc.) and open the root directory of the device.
- Look for the `notes.txt` file.
## Install and use
This is a Python program. Install it using `pip` / `poetry` or similar [from PyPi](https://pypi.org/project/tolino-notes/). If you don't yet have `pip` installed, [go here first](https://pip.pypa.io/en/stable/).
```shell
$ python -m pip install tolino-notes
```
In a new shell run:
```shell
$ tolino-notes --help
Usage: tolino-notes [OPTIONS]
Convert Tolino notes into useful formats
Options:
-i, --input-file FILE Original Tolino notes file [required]
-o, --output-dir DIRECTORY Folder for output files [required]
-f, --format [md|json] Output format [required]
-v, --verbose Verbose output
--help Show this message and exit.
```
For example to convert all your notes to markdown run:
```shell
$ mkdir output-dir
$ tolino-notes --input-file notes.txt --output-dir output-dir --format md
```
## Status
- Successfully in use with Tolino Shine 3.
- Supports extraction and conversion of highlights, bookmarks and notes.
- Support for DE, EN, ES, IT, NL, FR device-language settings, which is detected automatically.
- Supported output formats are Markdown and JSON.
Limitations:
Due to the unstructured nature of the `notes.txt`, it is a best-guess approach. The `notes.txt` format writes notes sequentially and it is not always clear in which order notes were taken. Also separating notes and highlights can only be done based on "quotes", which is not the most robust approach. In general, I believe 99% of your notes and highlights should be extracted properly.
Use the [issue tracker](https://github.com/BastiTee/tolino-notes/issues) to let me know about ideas and issues.
## Development
- The project is built based on [this](https://github.com/BastiTee/python-boilerplate) boilerplate.
- Run `make` to create a new virtual environment.
## License and attribution
This software is licensed under [Apache License 2.0](LICENSE.txt).
Raw data
{
"_id": null,
"home_page": null,
"name": "tolino-notes",
"maintainer": "Basti Tee",
"docs_url": null,
"requires_python": "<4.0.0,>=3.9.0",
"maintainer_email": "basti.tee@icloud.com",
"keywords": null,
"author": "Basti Tee",
"author_email": "basti.tee@icloud.com",
"download_url": null,
"platform": null,
"description": "# Tolino Notes\n\n> Convert Tolino notes into useful formats\n\n\n\n\n\nTolino stores your highlights and notes in a `notes.txt` file on your device. However that file has a strange structure and mixes books when you read multiple ones at a time. And the content depends on the language-setting of your device.\n\nThis project tries to close the gap by doing the heavy-lifting of parsing the file, sorting and converting to a commonly used format such as Markdown or JSON. \u2013 one file per book found in your `notes.txt`.\n\nWhere do I find this file?\n\n- Connect your Tolino to your computer via USB.\n- Use a file manager (Explorer, Finder, etc.) and open the root directory of the device.\n- Look for the `notes.txt` file.\n\n## Install and use\n\nThis is a Python program. Install it using `pip` / `poetry` or similar [from PyPi](https://pypi.org/project/tolino-notes/). If you don't yet have `pip` installed, [go here first](https://pip.pypa.io/en/stable/).\n\n```shell\n$ python -m pip install tolino-notes\n```\n\nIn a new shell run:\n\n```shell\n$ tolino-notes --help\nUsage: tolino-notes [OPTIONS]\n\n Convert Tolino notes into useful formats\n\nOptions:\n -i, --input-file FILE Original Tolino notes file [required]\n -o, --output-dir DIRECTORY Folder for output files [required]\n -f, --format [md|json] Output format [required]\n -v, --verbose Verbose output\n --help Show this message and exit.\n```\n\nFor example to convert all your notes to markdown run:\n\n```shell\n$ mkdir output-dir\n$ tolino-notes --input-file notes.txt --output-dir output-dir --format md\n```\n\n## Status\n\n- Successfully in use with Tolino Shine 3.\n- Supports extraction and conversion of highlights, bookmarks and notes.\n- Support for DE, EN, ES, IT, NL, FR device-language settings, which is detected automatically.\n- Supported output formats are Markdown and JSON.\n\nLimitations:\n\nDue to the unstructured nature of the `notes.txt`, it is a best-guess approach. The `notes.txt` format writes notes sequentially and it is not always clear in which order notes were taken. Also separating notes and highlights can only be done based on \"quotes\", which is not the most robust approach. In general, I believe 99% of your notes and highlights should be extracted properly.\n\nUse the [issue tracker](https://github.com/BastiTee/tolino-notes/issues) to let me know about ideas and issues.\n\n## Development\n\n- The project is built based on [this](https://github.com/BastiTee/python-boilerplate) boilerplate.\n- Run `make` to create a new virtual environment.\n\n## License and attribution\n\nThis software is licensed under [Apache License 2.0](LICENSE.txt).\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": null,
"version": "0.3.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94d44dc9b81a285238aeedf3ee25b0ec220f0092efd9fa84e896222f05908715",
"md5": "e436a73eb7319c4b979734f4aa0b71d7",
"sha256": "85f392589f4ea51b8e9e9b2913789e723777aa627a66629ff2a14e29d1eadf02"
},
"downloads": -1,
"filename": "tolino_notes-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e436a73eb7319c4b979734f4aa0b71d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.9.0",
"size": 11472,
"upload_time": "2024-12-28T09:45:49",
"upload_time_iso_8601": "2024-12-28T09:45:49.621411Z",
"url": "https://files.pythonhosted.org/packages/94/d4/4dc9b81a285238aeedf3ee25b0ec220f0092efd9fa84e896222f05908715/tolino_notes-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-28 09:45:49",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tolino-notes"
}
