# StickyText
This is an extremely simple app with the only purpose of loading a text file in an editor and syncing any changes between the
editor and the text file. It is intended to be used as a simple sticky note app to make quick jottings into text files. Additional features such
as autostarting and resizing, repositioning, and pinning to top, can be achieved by using additional tools.
## Usage
Execute the below command in a terminal
```commandline
python3 -m stickytext /path/to/textfile.txt
```
The app is configured to automatically save any changes as you type and to load any changes should the file be modified
from disk.
For convenience, any file changes loaded from the disk can be undone using the context menu
## Autostart
Starting the app on login can be achieved by adding an entry in your DE's autostart list
## Size / Position /Always on Top
To configure the size and position of the app, as well as to keep it pinned on top, it is recommended to use
devilspie2.
An example configuration is located in this repo as ./stickytext.lua. Simply copy this file to ~/.config/devilspie2 and adjust the window
name and desired geometry.
As an alternative, most modern desktop environments have the capability of pinning windows on top and some has the ability to remember the position
and size of the window.
# Use Case
The following setup allows for a simple synced sticky notes sytem between Android and Linux
1. On your computer, create one or more text files to be used as your sticky notes.
2. Setup StickyText to autostart and open the text files in a small, always on top window using the above mentioned devilspie2 config.
3. Sync the text with your phone (e.g. Syncthing, Nextcloud, etc.)
4. On Android, install [Simple Notes Pro](https://f-droid.org/packages/com.simplemobiletools.notes.pro/) from F-Droid
5. In Simple Notes, open the text file by using the Open Note menu item.
6. Create a Notes widget from the Simple Notes app to allow access to the notes on your home screen.
Raw data
{
"_id": null,
"home_page": "https://github.com/BeatLink/StickyText",
"name": "stickytext",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "note,notes,autosave,gtk,text,sticky,linux",
"author": "BeatLink",
"author_email": "beatlink+git@simplelogin.co",
"download_url": "https://files.pythonhosted.org/packages/cd/17/6aab7fc6f2f7d87a1a1d789ca4b10d34903a881828d6ec39d0db71bbf9bd/stickytext-0.1.0.tar.gz",
"platform": null,
"description": "# StickyText\n\nThis is an extremely simple app with the only purpose of loading a text file in an editor and syncing any changes between the\neditor and the text file. It is intended to be used as a simple sticky note app to make quick jottings into text files. Additional features such\nas autostarting and resizing, repositioning, and pinning to top, can be achieved by using additional tools.\n\n\n## Usage\n\nExecute the below command in a terminal\n```commandline\npython3 -m stickytext /path/to/textfile.txt\n```\n\nThe app is configured to automatically save any changes as you type and to load any changes should the file be modified\nfrom disk.\n\nFor convenience, any file changes loaded from the disk can be undone using the context menu\n\n\n## Autostart\nStarting the app on login can be achieved by adding an entry in your DE's autostart list\n\n## Size / Position /Always on Top\nTo configure the size and position of the app, as well as to keep it pinned on top, it is recommended to use\ndevilspie2.\n\nAn example configuration is located in this repo as ./stickytext.lua. Simply copy this file to ~/.config/devilspie2 and adjust the window\nname and desired geometry.\n\nAs an alternative, most modern desktop environments have the capability of pinning windows on top and some has the ability to remember the position\nand size of the window.\n\n\n# Use Case\n\nThe following setup allows for a simple synced sticky notes sytem between Android and Linux\n\n1. On your computer, create one or more text files to be used as your sticky notes.\n2. Setup StickyText to autostart and open the text files in a small, always on top window using the above mentioned devilspie2 config.\n3. Sync the text with your phone (e.g. Syncthing, Nextcloud, etc.)\n4. On Android, install [Simple Notes Pro](https://f-droid.org/packages/com.simplemobiletools.notes.pro/) from F-Droid\n5. In Simple Notes, open the text file by using the Open Note menu item.\n6. Create a Notes widget from the Simple Notes app to allow access to the notes on your home screen.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "An extremely simple app for showing a text file as a sticky note",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/BeatLink/StickyText/-/issues",
"Documentation": "https://github.com/BeatLink/StickyText",
"Homepage": "https://github.com/BeatLink/StickyText",
"Repository": "https://github.com/BeatLink/StickyText"
},
"split_keywords": [
"note",
"notes",
"autosave",
"gtk",
"text",
"sticky",
"linux"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b79cb287c1f15f0841ef232b7db88f761c235bddc407fdf4ff68bfe0613df68e",
"md5": "409611b28523a903b6e4d883c8cfeb09",
"sha256": "6925971f47465195c92362138ae21be0a10d3d0b97587a0e17aae2b5b2057685"
},
"downloads": -1,
"filename": "stickytext-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "409611b28523a903b6e4d883c8cfeb09",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 32806,
"upload_time": "2023-05-07T18:32:52",
"upload_time_iso_8601": "2023-05-07T18:32:52.312598Z",
"url": "https://files.pythonhosted.org/packages/b7/9c/b287c1f15f0841ef232b7db88f761c235bddc407fdf4ff68bfe0613df68e/stickytext-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cd176aab7fc6f2f7d87a1a1d789ca4b10d34903a881828d6ec39d0db71bbf9bd",
"md5": "a3fdbc2202e37d41787c8d03b1ea7063",
"sha256": "c2693a5516d6463a1790988e5e6c010d35ffa0dea975ae50bb4f84dcbdfbbc28"
},
"downloads": -1,
"filename": "stickytext-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "a3fdbc2202e37d41787c8d03b1ea7063",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 19240,
"upload_time": "2023-05-07T18:32:54",
"upload_time_iso_8601": "2023-05-07T18:32:54.989005Z",
"url": "https://files.pythonhosted.org/packages/cd/17/6aab7fc6f2f7d87a1a1d789ca4b10d34903a881828d6ec39d0db71bbf9bd/stickytext-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-07 18:32:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BeatLink",
"github_project": "StickyText",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "stickytext"
}
JSON
