pocket-editor 2026.11.18__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pocket_editor-2026.11.18/MANIFEST.in +2 -0
- pocket_editor-2026.11.18/PKG-INFO +62 -0
- pocket_editor-2026.11.18/README.md +45 -0
- pocket_editor-2026.11.18/pocket_editor.egg-info/PKG-INFO +62 -0
- pocket_editor-2026.11.18/pocket_editor.egg-info/SOURCES.txt +97 -0
- pocket_editor-2026.11.18/pocket_editor.egg-info/dependency_links.txt +1 -0
- pocket_editor-2026.11.18/pocket_editor.egg-info/entry_points.txt +2 -0
- pocket_editor-2026.11.18/pocket_editor.egg-info/top_level.txt +1 -0
- pocket_editor-2026.11.18/pocket_editor_app/__init__.py +2 -0
- pocket_editor-2026.11.18/pocket_editor_app/__main__.py +3 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/AUTHOR.md +9 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/INSTALL.md +47 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/PLUGIN_DEVELOPMENT.md +163 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/PUBLISHING.md +20 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/PYPI_PUBLISHING.md +38 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/README.md +367 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/RELEASE_NOTES.md +14 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/TEAM_WORK.md +129 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/command_palette.py +122 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/ai.html +30 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/assets/docs.css +1 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/assets/docs.js +71 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/assets/previews/ai-chat-narrow.png +0 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/assets/previews/ai-chat-preview.png +0 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/assets/previews/ai-chat-welcome.png +0 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/assets/previews/gui-preview.png +0 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/assets/search-index.js +1 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/build-your-ai.html +10 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/custom-ai.html +80 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/editor.html +33 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/handbook.html +150 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/index.html +28 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/php.html +45 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/plugin-development.html +119 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/plugins.html +129 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/reference.html +65 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/team-work.html +81 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/docs/terminal.html +17 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/editor_about.py +79 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/editor_session.py +175 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/examples/custom_ai/BUILD_PROMPT.md +11 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/examples/custom_ai/README.md +103 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/examples/php/README.md +28 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/examples/php/advanced_completion.php +21 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/examples/php/composer.json +5 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/examples/php/demo.php +16 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/examples/php/grouped.php +8 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/examples/php/includes/helpers.php +7 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/examples/php/includes/legacy.php +6 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/examples/php/src/Advanced/UserRepository.php +44 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/examples/php/src/Models/Customer.php +12 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/examples/php/src/Services/Greeter.php +17 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/plugin_manager.py +140 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor.py +1123 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/_git_settings.py +93 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/_php_completion.py +298 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/_php_tools.py +348 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/_team_chat.py +447 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/_team_chat_feed.py +123 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/_team_chat_ui.py +1017 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/_team_invites.py +56 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/_team_network.py +98 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/_team_project_sync.py +266 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/_team_relay.py +342 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/_terminal_colors.py +163 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/ai_assistant.py +829 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/code_theme.py +169 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/editor_commands.py +125 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/git_project.py +616 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/my_ai_example.py +600 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/php_completion.py +491 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/php_formatter.py +159 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/plugin_builder.py +236 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/project_explorer.py +363 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/project_terminal.py +434 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/python_formatter.py +143 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/rich_text.py +227 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/search_replace.py +218 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/syntax_diagnostics.py +178 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/team_project.py +59 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/text_formatting.py +153 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/pocket_editor_plugins/word_count.py +10 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/quick_open.py +144 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/split_editor.py +157 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/tools/ai/chat_ai.py +1021 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/tools/ai/code_ai.py +888 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/tools/build_pypi.py +47 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/tools/build_release.py +111 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/tools/check_ai_online.py +201 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/tools/check_pypi.py +37 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/tools/documentation/build_docs.py +326 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/tools/php/format.cjs +15 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/tools/php/package-lock.json +1505 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/tools/php/package.json +10 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/tools/team_live_test.py +289 -0
- pocket_editor-2026.11.18/pocket_editor_app/_payload/tools/team_relay.py +9 -0
- pocket_editor-2026.11.18/pocket_editor_app/launcher.py +60 -0
- pocket_editor-2026.11.18/pyproject.toml +34 -0
- pocket_editor-2026.11.18/setup.cfg +4 -0
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: pocket-editor
|
|
3
|
+
Version: 2026.11.18
|
|
4
|
+
Summary: A Python/Tkinter code editor with project, Git and team collaboration plugins
|
|
5
|
+
Author-email: Somi Douth <somidouth@gmail.com>
|
|
6
|
+
Project-URL: Homepage, https://sourceforge.net/projects/pocket-editor/
|
|
7
|
+
Project-URL: Source, https://github.com/somidouth-collab/pocket-editor
|
|
8
|
+
Project-URL: Issues, https://github.com/somidouth-collab/pocket-editor/issues
|
|
9
|
+
Project-URL: Documentation, https://github.com/somidouth-collab/pocket-editor/blob/main/INSTALL.md
|
|
10
|
+
Keywords: editor,tkinter,git,collaboration
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Environment :: X11 Applications
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Topic :: Text Editors
|
|
15
|
+
Requires-Python: >=3.9
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
|
|
18
|
+
# Pocket Editor
|
|
19
|
+
|
|
20
|
+
Created by **Somi Douth** · somidouth@gmail.com
|
|
21
|
+
|
|
22
|
+
A desktop code editor built with Python and Tkinter, with Project Explorer, Git integration, optional AI tools, and host/client team collaboration.
|
|
23
|
+
|
|
24
|
+
## Install and launch
|
|
25
|
+
|
|
26
|
+
Python 3.9 or newer and Tkinter are required. On Debian/Ubuntu:
|
|
27
|
+
|
|
28
|
+
```sh
|
|
29
|
+
sudo apt install python3-tk pipx
|
|
30
|
+
pipx install pocket-editor
|
|
31
|
+
pocket-editor
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Alternatively, install in a virtual environment:
|
|
35
|
+
|
|
36
|
+
```sh
|
|
37
|
+
python3 -m venv --system-site-packages .venv
|
|
38
|
+
.venv/bin/python -m pip install pocket-editor
|
|
39
|
+
.venv/bin/pocket-editor
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Windows: install Python with Tcl/Tk enabled, then `py -m pip install pocket-editor`. macOS requires a Python installation with Tkinter. Windows and macOS execution has not yet been verified.
|
|
43
|
+
|
|
44
|
+
## Features
|
|
45
|
+
|
|
46
|
+
- Project Explorer with Open, Save and Load project controls.
|
|
47
|
+
- Git initialization, repository settings, commit, pull and push.
|
|
48
|
+
- Host/client project sharing with per-client invitation files.
|
|
49
|
+
- Group text chat and audio, video and file attachments.
|
|
50
|
+
- Optional internet relay and AI provider integration.
|
|
51
|
+
- Offline HTML help and an extensible Python plugin system.
|
|
52
|
+
|
|
53
|
+
The core uses the Python standard library. Git features require Git. PHP features require Node.js/npm and a separate optional dependency installation. AI services require your own provider configuration.
|
|
54
|
+
|
|
55
|
+
Application files are copied to a version-specific writable user directory on first launch, so plugins and settings do not write into Python site-packages. On Linux this is `$XDG_DATA_HOME/pocket-editor/pypi/2026.11.18`, defaulting to `~/.local/share/pocket-editor/pypi/2026.11.18`. Windows uses LocalAppData and macOS uses Application Support. `POCKET_EDITOR_HOME` overrides the base directory. Runtime settings are retained when reinstalling the same version; different versions have separate runtime settings.
|
|
56
|
+
|
|
57
|
+
- [Source](https://github.com/somidouth-collab/pocket-editor)
|
|
58
|
+
- [Installation guide](https://github.com/somidouth-collab/pocket-editor/blob/main/INSTALL.md)
|
|
59
|
+
- [Support and bug reports](https://github.com/somidouth-collab/pocket-editor/issues)
|
|
60
|
+
- [SourceForge downloads](https://sourceforge.net/projects/pocket-editor/)
|
|
61
|
+
|
|
62
|
+
The project owner has not yet selected a license.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Pocket Editor
|
|
2
|
+
|
|
3
|
+
Created by **Somi Douth** · somidouth@gmail.com
|
|
4
|
+
|
|
5
|
+
A desktop code editor built with Python and Tkinter, with Project Explorer, Git integration, optional AI tools, and host/client team collaboration.
|
|
6
|
+
|
|
7
|
+
## Install and launch
|
|
8
|
+
|
|
9
|
+
Python 3.9 or newer and Tkinter are required. On Debian/Ubuntu:
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
sudo apt install python3-tk pipx
|
|
13
|
+
pipx install pocket-editor
|
|
14
|
+
pocket-editor
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Alternatively, install in a virtual environment:
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
python3 -m venv --system-site-packages .venv
|
|
21
|
+
.venv/bin/python -m pip install pocket-editor
|
|
22
|
+
.venv/bin/pocket-editor
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Windows: install Python with Tcl/Tk enabled, then `py -m pip install pocket-editor`. macOS requires a Python installation with Tkinter. Windows and macOS execution has not yet been verified.
|
|
26
|
+
|
|
27
|
+
## Features
|
|
28
|
+
|
|
29
|
+
- Project Explorer with Open, Save and Load project controls.
|
|
30
|
+
- Git initialization, repository settings, commit, pull and push.
|
|
31
|
+
- Host/client project sharing with per-client invitation files.
|
|
32
|
+
- Group text chat and audio, video and file attachments.
|
|
33
|
+
- Optional internet relay and AI provider integration.
|
|
34
|
+
- Offline HTML help and an extensible Python plugin system.
|
|
35
|
+
|
|
36
|
+
The core uses the Python standard library. Git features require Git. PHP features require Node.js/npm and a separate optional dependency installation. AI services require your own provider configuration.
|
|
37
|
+
|
|
38
|
+
Application files are copied to a version-specific writable user directory on first launch, so plugins and settings do not write into Python site-packages. On Linux this is `$XDG_DATA_HOME/pocket-editor/pypi/2026.11.18`, defaulting to `~/.local/share/pocket-editor/pypi/2026.11.18`. Windows uses LocalAppData and macOS uses Application Support. `POCKET_EDITOR_HOME` overrides the base directory. Runtime settings are retained when reinstalling the same version; different versions have separate runtime settings.
|
|
39
|
+
|
|
40
|
+
- [Source](https://github.com/somidouth-collab/pocket-editor)
|
|
41
|
+
- [Installation guide](https://github.com/somidouth-collab/pocket-editor/blob/main/INSTALL.md)
|
|
42
|
+
- [Support and bug reports](https://github.com/somidouth-collab/pocket-editor/issues)
|
|
43
|
+
- [SourceForge downloads](https://sourceforge.net/projects/pocket-editor/)
|
|
44
|
+
|
|
45
|
+
The project owner has not yet selected a license.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: pocket-editor
|
|
3
|
+
Version: 2026.11.18
|
|
4
|
+
Summary: A Python/Tkinter code editor with project, Git and team collaboration plugins
|
|
5
|
+
Author-email: Somi Douth <somidouth@gmail.com>
|
|
6
|
+
Project-URL: Homepage, https://sourceforge.net/projects/pocket-editor/
|
|
7
|
+
Project-URL: Source, https://github.com/somidouth-collab/pocket-editor
|
|
8
|
+
Project-URL: Issues, https://github.com/somidouth-collab/pocket-editor/issues
|
|
9
|
+
Project-URL: Documentation, https://github.com/somidouth-collab/pocket-editor/blob/main/INSTALL.md
|
|
10
|
+
Keywords: editor,tkinter,git,collaboration
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Environment :: X11 Applications
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Topic :: Text Editors
|
|
15
|
+
Requires-Python: >=3.9
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
|
|
18
|
+
# Pocket Editor
|
|
19
|
+
|
|
20
|
+
Created by **Somi Douth** · somidouth@gmail.com
|
|
21
|
+
|
|
22
|
+
A desktop code editor built with Python and Tkinter, with Project Explorer, Git integration, optional AI tools, and host/client team collaboration.
|
|
23
|
+
|
|
24
|
+
## Install and launch
|
|
25
|
+
|
|
26
|
+
Python 3.9 or newer and Tkinter are required. On Debian/Ubuntu:
|
|
27
|
+
|
|
28
|
+
```sh
|
|
29
|
+
sudo apt install python3-tk pipx
|
|
30
|
+
pipx install pocket-editor
|
|
31
|
+
pocket-editor
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Alternatively, install in a virtual environment:
|
|
35
|
+
|
|
36
|
+
```sh
|
|
37
|
+
python3 -m venv --system-site-packages .venv
|
|
38
|
+
.venv/bin/python -m pip install pocket-editor
|
|
39
|
+
.venv/bin/pocket-editor
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Windows: install Python with Tcl/Tk enabled, then `py -m pip install pocket-editor`. macOS requires a Python installation with Tkinter. Windows and macOS execution has not yet been verified.
|
|
43
|
+
|
|
44
|
+
## Features
|
|
45
|
+
|
|
46
|
+
- Project Explorer with Open, Save and Load project controls.
|
|
47
|
+
- Git initialization, repository settings, commit, pull and push.
|
|
48
|
+
- Host/client project sharing with per-client invitation files.
|
|
49
|
+
- Group text chat and audio, video and file attachments.
|
|
50
|
+
- Optional internet relay and AI provider integration.
|
|
51
|
+
- Offline HTML help and an extensible Python plugin system.
|
|
52
|
+
|
|
53
|
+
The core uses the Python standard library. Git features require Git. PHP features require Node.js/npm and a separate optional dependency installation. AI services require your own provider configuration.
|
|
54
|
+
|
|
55
|
+
Application files are copied to a version-specific writable user directory on first launch, so plugins and settings do not write into Python site-packages. On Linux this is `$XDG_DATA_HOME/pocket-editor/pypi/2026.11.18`, defaulting to `~/.local/share/pocket-editor/pypi/2026.11.18`. Windows uses LocalAppData and macOS uses Application Support. `POCKET_EDITOR_HOME` overrides the base directory. Runtime settings are retained when reinstalling the same version; different versions have separate runtime settings.
|
|
56
|
+
|
|
57
|
+
- [Source](https://github.com/somidouth-collab/pocket-editor)
|
|
58
|
+
- [Installation guide](https://github.com/somidouth-collab/pocket-editor/blob/main/INSTALL.md)
|
|
59
|
+
- [Support and bug reports](https://github.com/somidouth-collab/pocket-editor/issues)
|
|
60
|
+
- [SourceForge downloads](https://sourceforge.net/projects/pocket-editor/)
|
|
61
|
+
|
|
62
|
+
The project owner has not yet selected a license.
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
MANIFEST.in
|
|
2
|
+
README.md
|
|
3
|
+
pyproject.toml
|
|
4
|
+
pocket_editor.egg-info/PKG-INFO
|
|
5
|
+
pocket_editor.egg-info/SOURCES.txt
|
|
6
|
+
pocket_editor.egg-info/dependency_links.txt
|
|
7
|
+
pocket_editor.egg-info/entry_points.txt
|
|
8
|
+
pocket_editor.egg-info/top_level.txt
|
|
9
|
+
pocket_editor_app/__init__.py
|
|
10
|
+
pocket_editor_app/__main__.py
|
|
11
|
+
pocket_editor_app/launcher.py
|
|
12
|
+
pocket_editor_app/_payload/AUTHOR.md
|
|
13
|
+
pocket_editor_app/_payload/INSTALL.md
|
|
14
|
+
pocket_editor_app/_payload/PLUGIN_DEVELOPMENT.md
|
|
15
|
+
pocket_editor_app/_payload/PUBLISHING.md
|
|
16
|
+
pocket_editor_app/_payload/PYPI_PUBLISHING.md
|
|
17
|
+
pocket_editor_app/_payload/README.md
|
|
18
|
+
pocket_editor_app/_payload/RELEASE_NOTES.md
|
|
19
|
+
pocket_editor_app/_payload/TEAM_WORK.md
|
|
20
|
+
pocket_editor_app/_payload/command_palette.py
|
|
21
|
+
pocket_editor_app/_payload/editor_about.py
|
|
22
|
+
pocket_editor_app/_payload/editor_session.py
|
|
23
|
+
pocket_editor_app/_payload/plugin_manager.py
|
|
24
|
+
pocket_editor_app/_payload/pocket_editor.py
|
|
25
|
+
pocket_editor_app/_payload/quick_open.py
|
|
26
|
+
pocket_editor_app/_payload/split_editor.py
|
|
27
|
+
pocket_editor_app/_payload/docs/ai.html
|
|
28
|
+
pocket_editor_app/_payload/docs/build-your-ai.html
|
|
29
|
+
pocket_editor_app/_payload/docs/custom-ai.html
|
|
30
|
+
pocket_editor_app/_payload/docs/editor.html
|
|
31
|
+
pocket_editor_app/_payload/docs/handbook.html
|
|
32
|
+
pocket_editor_app/_payload/docs/index.html
|
|
33
|
+
pocket_editor_app/_payload/docs/php.html
|
|
34
|
+
pocket_editor_app/_payload/docs/plugin-development.html
|
|
35
|
+
pocket_editor_app/_payload/docs/plugins.html
|
|
36
|
+
pocket_editor_app/_payload/docs/reference.html
|
|
37
|
+
pocket_editor_app/_payload/docs/team-work.html
|
|
38
|
+
pocket_editor_app/_payload/docs/terminal.html
|
|
39
|
+
pocket_editor_app/_payload/docs/assets/docs.css
|
|
40
|
+
pocket_editor_app/_payload/docs/assets/docs.js
|
|
41
|
+
pocket_editor_app/_payload/docs/assets/search-index.js
|
|
42
|
+
pocket_editor_app/_payload/docs/assets/previews/ai-chat-narrow.png
|
|
43
|
+
pocket_editor_app/_payload/docs/assets/previews/ai-chat-preview.png
|
|
44
|
+
pocket_editor_app/_payload/docs/assets/previews/ai-chat-welcome.png
|
|
45
|
+
pocket_editor_app/_payload/docs/assets/previews/gui-preview.png
|
|
46
|
+
pocket_editor_app/_payload/examples/custom_ai/BUILD_PROMPT.md
|
|
47
|
+
pocket_editor_app/_payload/examples/custom_ai/README.md
|
|
48
|
+
pocket_editor_app/_payload/examples/php/README.md
|
|
49
|
+
pocket_editor_app/_payload/examples/php/advanced_completion.php
|
|
50
|
+
pocket_editor_app/_payload/examples/php/composer.json
|
|
51
|
+
pocket_editor_app/_payload/examples/php/demo.php
|
|
52
|
+
pocket_editor_app/_payload/examples/php/grouped.php
|
|
53
|
+
pocket_editor_app/_payload/examples/php/includes/helpers.php
|
|
54
|
+
pocket_editor_app/_payload/examples/php/includes/legacy.php
|
|
55
|
+
pocket_editor_app/_payload/examples/php/src/Advanced/UserRepository.php
|
|
56
|
+
pocket_editor_app/_payload/examples/php/src/Models/Customer.php
|
|
57
|
+
pocket_editor_app/_payload/examples/php/src/Services/Greeter.php
|
|
58
|
+
pocket_editor_app/_payload/pocket_editor_plugins/_git_settings.py
|
|
59
|
+
pocket_editor_app/_payload/pocket_editor_plugins/_php_completion.py
|
|
60
|
+
pocket_editor_app/_payload/pocket_editor_plugins/_php_tools.py
|
|
61
|
+
pocket_editor_app/_payload/pocket_editor_plugins/_team_chat.py
|
|
62
|
+
pocket_editor_app/_payload/pocket_editor_plugins/_team_chat_feed.py
|
|
63
|
+
pocket_editor_app/_payload/pocket_editor_plugins/_team_chat_ui.py
|
|
64
|
+
pocket_editor_app/_payload/pocket_editor_plugins/_team_invites.py
|
|
65
|
+
pocket_editor_app/_payload/pocket_editor_plugins/_team_network.py
|
|
66
|
+
pocket_editor_app/_payload/pocket_editor_plugins/_team_project_sync.py
|
|
67
|
+
pocket_editor_app/_payload/pocket_editor_plugins/_team_relay.py
|
|
68
|
+
pocket_editor_app/_payload/pocket_editor_plugins/_terminal_colors.py
|
|
69
|
+
pocket_editor_app/_payload/pocket_editor_plugins/ai_assistant.py
|
|
70
|
+
pocket_editor_app/_payload/pocket_editor_plugins/code_theme.py
|
|
71
|
+
pocket_editor_app/_payload/pocket_editor_plugins/editor_commands.py
|
|
72
|
+
pocket_editor_app/_payload/pocket_editor_plugins/git_project.py
|
|
73
|
+
pocket_editor_app/_payload/pocket_editor_plugins/my_ai_example.py
|
|
74
|
+
pocket_editor_app/_payload/pocket_editor_plugins/php_completion.py
|
|
75
|
+
pocket_editor_app/_payload/pocket_editor_plugins/php_formatter.py
|
|
76
|
+
pocket_editor_app/_payload/pocket_editor_plugins/plugin_builder.py
|
|
77
|
+
pocket_editor_app/_payload/pocket_editor_plugins/project_explorer.py
|
|
78
|
+
pocket_editor_app/_payload/pocket_editor_plugins/project_terminal.py
|
|
79
|
+
pocket_editor_app/_payload/pocket_editor_plugins/python_formatter.py
|
|
80
|
+
pocket_editor_app/_payload/pocket_editor_plugins/rich_text.py
|
|
81
|
+
pocket_editor_app/_payload/pocket_editor_plugins/search_replace.py
|
|
82
|
+
pocket_editor_app/_payload/pocket_editor_plugins/syntax_diagnostics.py
|
|
83
|
+
pocket_editor_app/_payload/pocket_editor_plugins/team_project.py
|
|
84
|
+
pocket_editor_app/_payload/pocket_editor_plugins/text_formatting.py
|
|
85
|
+
pocket_editor_app/_payload/pocket_editor_plugins/word_count.py
|
|
86
|
+
pocket_editor_app/_payload/tools/build_pypi.py
|
|
87
|
+
pocket_editor_app/_payload/tools/build_release.py
|
|
88
|
+
pocket_editor_app/_payload/tools/check_ai_online.py
|
|
89
|
+
pocket_editor_app/_payload/tools/check_pypi.py
|
|
90
|
+
pocket_editor_app/_payload/tools/team_live_test.py
|
|
91
|
+
pocket_editor_app/_payload/tools/team_relay.py
|
|
92
|
+
pocket_editor_app/_payload/tools/ai/chat_ai.py
|
|
93
|
+
pocket_editor_app/_payload/tools/ai/code_ai.py
|
|
94
|
+
pocket_editor_app/_payload/tools/documentation/build_docs.py
|
|
95
|
+
pocket_editor_app/_payload/tools/php/format.cjs
|
|
96
|
+
pocket_editor_app/_payload/tools/php/package-lock.json
|
|
97
|
+
pocket_editor_app/_payload/tools/php/package.json
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
pocket_editor_app
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Install Pocket Editor
|
|
2
|
+
|
|
3
|
+
Created by Somi Douth · somidouth@gmail.com
|
|
4
|
+
|
|
5
|
+
Pocket Editor is a Python source release. It requires Python 3.9 or newer and Tkinter.
|
|
6
|
+
|
|
7
|
+
## Debian and Ubuntu
|
|
8
|
+
|
|
9
|
+
Install the core requirements:
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
sudo apt update
|
|
13
|
+
sudo apt install python3 python3-tk unzip
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Download `Pocket-Editor-2026.11.18.zip` from the release page, then run:
|
|
17
|
+
|
|
18
|
+
```sh
|
|
19
|
+
unzip Pocket-Editor-2026.11.18.zip
|
|
20
|
+
cd Pocket-Editor-2026.11.18
|
|
21
|
+
python3 -B pocket_editor.py
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Alternatively, clone the source:
|
|
25
|
+
|
|
26
|
+
```sh
|
|
27
|
+
git clone https://github.com/somidouth-collab/pocket-editor.git
|
|
28
|
+
cd pocket-editor
|
|
29
|
+
python3 -B pocket_editor.py
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Windows and macOS
|
|
33
|
+
|
|
34
|
+
Install Python with Tkinter support. Extract the source ZIP and open a terminal in its folder. On Windows run `py pocket_editor.py`; on macOS run `python3 pocket_editor.py`. These platforms have not yet been verified.
|
|
35
|
+
|
|
36
|
+
## Optional features
|
|
37
|
+
|
|
38
|
+
The core editor requires no pip packages. PHP tools require Node.js/npm and `npm ci --prefix tools/php --ignore-scripts`. Python formatting optionally uses Black. AI services require each user's own provider configuration. Team internet sharing offers relay installation in its GUI.
|
|
39
|
+
|
|
40
|
+
## Help and support
|
|
41
|
+
|
|
42
|
+
- Source and documentation: https://github.com/somidouth-collab/pocket-editor
|
|
43
|
+
- Downloads: https://github.com/somidouth-collab/pocket-editor/releases
|
|
44
|
+
- Report a bug or request a feature: https://github.com/somidouth-collab/pocket-editor/issues
|
|
45
|
+
- SourceForge project: https://sourceforge.net/projects/pocket-editor/
|
|
46
|
+
|
|
47
|
+
For bug reports, include your operating system, Python version, reproduction steps, and error message. Remove credentials and invitation keys before sharing logs.
|
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
# Pocket Editor plugin development
|
|
2
|
+
|
|
3
|
+
## Start with Plugin Builder
|
|
4
|
+
|
|
5
|
+
1. Open Extensions → Plugin Builder… (restart the editor or choose Extensions → Load New Plugins if the builder is newly installed).
|
|
6
|
+
2. Enter a unique plugin ID such as `my_tools`, a command label, and an optional description.
|
|
7
|
+
3. Choose Simple command, Text transform, Tool window, or Events and services.
|
|
8
|
+
4. Review Code preview. Previewing validates and compiles the generated source without running it.
|
|
9
|
+
5. Click Create & load. The builder creates `pocket_editor_plugins/<plugin_id>.py`, loads it, and opens its source in a file tab. Existing files are never overwritten.
|
|
10
|
+
6. Run your command from Extensions. Add a shortcut button through Extensions → Add to toolbar.
|
|
11
|
+
7. Edit the source and save it. Restart the editor to apply changes to a plugin already loaded. Load New Plugins loads only files not already loaded; it does not reload edited plugins.
|
|
12
|
+
|
|
13
|
+
The builder needs only Python and Tkinter. Templates are starting points, not a package installer or an AI code generator.
|
|
14
|
+
|
|
15
|
+
## Minimal plugin
|
|
16
|
+
|
|
17
|
+
```python
|
|
18
|
+
from tkinter import messagebox
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
def register(api):
|
|
22
|
+
def run():
|
|
23
|
+
messagebox.showinfo("My command", f"{len(api.get_text()):,} characters")
|
|
24
|
+
|
|
25
|
+
api.add_command("My command", run)
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Place this file directly in `pocket_editor_plugins` beside `pocket_editor.py`. Files beginning with `_` are helpers and are not loaded as plugins. The filename stem is the plugin ID. Use a distinct command label so users can recognize your plugin.
|
|
29
|
+
|
|
30
|
+
The loader executes each Python file, then calls `register(api)`. Commands are installed after registration succeeds. Keep imports and registration quick; do expensive work when a command runs. A plugin runs with the editor's permissions: install code you trust. `--safe-mode` starts without plugins.
|
|
31
|
+
|
|
32
|
+
## Public PluginAPI reference
|
|
33
|
+
|
|
34
|
+
| API | Behavior |
|
|
35
|
+
| --- | --- |
|
|
36
|
+
| `api.plugin_id` | Plugin ID, derived from the filename stem. |
|
|
37
|
+
| `api.add_command(label, callback)` | Register a nonempty menu label and a callable taking no arguments. Call during `register`. |
|
|
38
|
+
| `api.get_text()` | Return the entire active tab as a string, excluding Tk's automatic trailing newline. |
|
|
39
|
+
| `api.replace_text(text)` | Replace the active tab's text as one undo group. Marks it modified; does not save to disk. Requires a string. |
|
|
40
|
+
| `api.get_path()` | Return the active tab's `pathlib.Path`, or `None` for an untitled tab. |
|
|
41
|
+
| `api.list_plugins()` | Return sorted loaded plugin IDs as a tuple. |
|
|
42
|
+
| `api.on(event, callback)` | Subscribe to an event; returns a callable that unsubscribes. Callback receives keyword arguments including `source`. |
|
|
43
|
+
| `api.emit(event, **payload)` | Queue an event for idle delivery to loaded plugins. The editor supplies `source=api.plugin_id`; do not put `source` in payload. |
|
|
44
|
+
| `api.provide_service(name, callback)` | Register a synchronous service named `plugin_id.name`. Names must be nonempty and contain no dot. Duplicate names in a plugin are rejected. |
|
|
45
|
+
| `api.list_services()` | Return sorted qualified service names as a tuple. |
|
|
46
|
+
| `api.call_service("plugin_id.name", *args, **kwargs)` | Call a loaded service and return its result. Raises `LookupError` when unavailable. |
|
|
47
|
+
| `api.on_cleanup(callback)` | Register a no-argument cleanup callback, run in reverse order on editor exit or failed plugin registration. |
|
|
48
|
+
|
|
49
|
+
These APIs and Tk operations must be used on the GUI thread. `list_plugins()` and `list_services()` reflect plugins that have finished loading; dependencies may not yet be available during registration. Resolve optional services when commands run and catch `LookupError`.
|
|
50
|
+
|
|
51
|
+
## Events
|
|
52
|
+
|
|
53
|
+
```python
|
|
54
|
+
def register(api):
|
|
55
|
+
def saved(source, path, **payload):
|
|
56
|
+
print("Saved", path, "from", source)
|
|
57
|
+
|
|
58
|
+
api.on("document_saved", saved)
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
| Event | Source / payload |
|
|
62
|
+
| --- | --- |
|
|
63
|
+
| `document_changed` | Core source `editor`, no required extra fields; queued and coalesced for edits and tab switches. Some plugins also emit this event. |
|
|
64
|
+
| `document_switched` | Core source `editor`, no extra fields; delivered when selecting another tab. |
|
|
65
|
+
| `document_saved` | Core source `editor`, `path` string. Delivery is queued; another tab may be active by delivery time. |
|
|
66
|
+
| `plugin_loaded` | Loaded plugin's ID as source, `plugin_id` string. |
|
|
67
|
+
| `document_formatted` | Formatter plugin source; payload varies by formatter. |
|
|
68
|
+
| `project_changed` | Project plugin source; payload varies, including file actions or project directory. |
|
|
69
|
+
|
|
70
|
+
Use callbacks accepting `**payload` for compatibility with extra fields. Namespaced custom events such as `my_tools.completed` avoid collisions. Do not emit the same event unconditionally from its handler: that creates an endless feedback loop. Subscription cleanup is automatic; use the unsubscribe callable when you want to stop earlier.
|
|
71
|
+
|
|
72
|
+
## Services
|
|
73
|
+
|
|
74
|
+
```python
|
|
75
|
+
def register(api):
|
|
76
|
+
api.provide_service("word_count", lambda: len(api.get_text().split()))
|
|
77
|
+
|
|
78
|
+
def show_count():
|
|
79
|
+
try:
|
|
80
|
+
count = api.call_service("other_plugin.word_count")
|
|
81
|
+
except LookupError:
|
|
82
|
+
return # Optional dependency is not loaded.
|
|
83
|
+
print(count)
|
|
84
|
+
|
|
85
|
+
api.add_command("Use another plugin", show_count)
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Service calls are synchronous. Keep them short and handle failures at the caller. There is no manifest, automatic dependency installation, or dependency-order resolver; plugin files load in filename order.
|
|
89
|
+
|
|
90
|
+
## Two plugins communicating
|
|
91
|
+
|
|
92
|
+
The builder's Plugin communication tab lists loaded plugins and their available services. Refresh services after loading another plugin. The Events and services template publishes `<plugin_id>.word_count`, sends `<plugin_id>.counted` when its command runs, and forwards saves as `<plugin_id>.observed_save`.
|
|
93
|
+
|
|
94
|
+
For a complete example, create an Events and services plugin with ID `counter`. Then create `counter_view.py` with this code:
|
|
95
|
+
|
|
96
|
+
```python
|
|
97
|
+
from tkinter import messagebox
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
def register(api):
|
|
101
|
+
def counted(source, count, **payload):
|
|
102
|
+
# Called asynchronously after counter emits its counted event.
|
|
103
|
+
print(f"{source} counted {count} words")
|
|
104
|
+
|
|
105
|
+
api.on("counter.counted", counted)
|
|
106
|
+
|
|
107
|
+
def show_count():
|
|
108
|
+
# Service calls return a result immediately on the GUI thread.
|
|
109
|
+
try:
|
|
110
|
+
count = api.call_service("counter.word_count")
|
|
111
|
+
except LookupError:
|
|
112
|
+
messagebox.showinfo("Counter", "Load the counter plugin first.")
|
|
113
|
+
return
|
|
114
|
+
messagebox.showinfo("Counter", f"{count:,} words in the active tab")
|
|
115
|
+
|
|
116
|
+
api.add_command("Show shared word count", show_count)
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
Choose Extensions → Load New Plugins. Run counter's command to send an event to `counter_view`; run Show shared word count to request counter's service. Both use the active file tab. Events carry notifications; services return requested values. Plugins need no direct Python imports of one another. Calls belong in command callbacks rather than module-level code, because the other plugin may still be loading.
|
|
120
|
+
|
|
121
|
+
## GUI tools and cleanup
|
|
122
|
+
|
|
123
|
+
The Tool window template uses `api._editor.root`, an internal integration interface used by bundled plugins. This is distinct from the public API above and may change. Prefer `ttk` widgets to inherit the editor theme. Keep one window instance, raise it when the command is repeated, and register a cleanup callback to destroy it.
|
|
124
|
+
|
|
125
|
+
The editor's `api._editor.buffer` is a stable interface forwarding to the selected tab. Do not cache a tab's text, path, selection, or cursor and later assume that tab is still active. Read them when a command runs. Each tab keeps its own text, tags, undo history, and cursor. Plain-text saving does not preserve rich-text styles; use a formatted copy for those.
|
|
126
|
+
|
|
127
|
+
For slow work, capture inputs on the GUI thread, use a worker for computation or I/O, and return results through a queue polled with `root.after` from the GUI thread. Workers must not call Tk or PluginAPI methods. Before applying a result, verify the captured document generation and revision against `api._editor.document_generation` and `api._editor.document_revision`; discard stale results after edits or tab switches. These counters are internal integration details. Stop workers, cancel scheduled callbacks, close windows, and remove custom bindings in `on_cleanup`. Do not block shutdown indefinitely.
|
|
128
|
+
|
|
129
|
+
## Test and troubleshoot
|
|
130
|
+
|
|
131
|
+
- Test a generated transform with `transform("Hello")` before wiring up more UI.
|
|
132
|
+
- Use a scratch file. Run the command, switch tabs, and check Undo, unsaved markers, and Save.
|
|
133
|
+
- For windows, repeat the command and close/reopen the window; verify editor shutdown.
|
|
134
|
+
- For services, check `list_services()` and handle missing dependencies.
|
|
135
|
+
- A syntax/import/registration error appears in Plugin loading errors. Fix the file and restart, or use Load New Plugins if that file never loaded successfully.
|
|
136
|
+
- A command exception appears in Plugin error. Registration failures roll back registered API commands/services/subscriptions and invoke registered cleanup callbacks; external side effects require your own cleanup.
|
|
137
|
+
- If startup fails because of custom code, launch `python3 -B pocket_editor.py --safe-mode`, fix the plugin, and restart normally.
|
|
138
|
+
|
|
139
|
+
Run the builder tests from the project directory on a graphical desktop:
|
|
140
|
+
|
|
141
|
+
```sh
|
|
142
|
+
python3 -B -m unittest -v test_plugin_builder
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
## Inspect with Plugin Manager
|
|
146
|
+
|
|
147
|
+
Settings → Plugin Manager lists installed plugins and shows registered commands, subscribed events, callable services, and recorded registration/command errors. Enable or disable startup loading there. Disable takes effect after restart for already-loaded plugins; Load new plugins can load newly enabled or repaired plugins that have not loaded successfully yet. Safe mode still provides this manager through Settings. Inspect a plugin's services before connecting it to another plugin, and use the builder's Plugin communication tab for a combined service list.
|
|
148
|
+
|
|
149
|
+
## Optional project tools
|
|
150
|
+
|
|
151
|
+
`git_project.ensure_repository(folder)` synchronously checks a local folder, initializes Git if missing, registers the actual working-tree root, and returns that root as a Path. It works before the Git window opens and does not clone, stage, commit, or contact a remote. Existing repositories are reused, including when a subfolder is supplied. Invalid existing Git metadata produces an error instead of being replaced.
|
|
152
|
+
|
|
153
|
+
`git_project.get_repository()` returns the registered root or None. It does not return an uninitialized typed folder. `git_project.get_project()` is a compatibility alias. `git_project.open_project(folder)` prepares/registers the folder and opens the independent Git UI. Services run on the GUI thread; local setup commands use bounded timeouts and setup is refused while another Git operation is running.
|
|
154
|
+
|
|
155
|
+
```python
|
|
156
|
+
root = api.call_service("git_project.ensure_repository", project_folder)
|
|
157
|
+
# Other plugins can retrieve the same registered root later:
|
|
158
|
+
root = api.call_service("git_project.get_repository")
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
Subscribe to `git_project.repository_changed` to observe registration changes. The payload contains `path` (string) and `initialized` (bool), plus the usual `source`. Resolve optional services when a user invokes a command and handle LookupError if Git Project is unavailable. Handle ValueError, OSError, or RuntimeError for invalid paths, missing Git, and Git failures.
|
|
162
|
+
|
|
163
|
+
The Git plugin works without Project Explorer or Team Project. Project Explorer Actions → Git Project selects, prepares, and registers its chosen folder. `team_project.open_project(folder)` separately opens hosted project collaboration and refuses to switch an active connection.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Publishing Pocket Editor
|
|
2
|
+
|
|
3
|
+
Author: **Somi Douth** · somidouth@gmail.com
|
|
4
|
+
|
|
5
|
+
## Build the source release
|
|
6
|
+
|
|
7
|
+
From the project directory:
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
python3 -B tools/documentation/build_docs.py
|
|
11
|
+
python3 -B tools/build_release.py
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
The release is written to `dist/Pocket-Editor-<date>.zip`, together with a SHA-256 checksum and release information. Extract it, enter its folder, and run `python3 -B pocket_editor.py`. Tkinter must be installed. On Windows, use `py pocket_editor.py`. Optional PHP dependencies are installed separately with `npm ci --prefix tools/php`; Python formatting optionally uses Black. AI backend source is included in tools/ai, but credentials are supplied by each user separately.
|
|
15
|
+
|
|
16
|
+
The archive is a source distribution, not a standalone Windows/macOS/Linux executable. It contains a file manifest and the published author details. Personal settings, sessions/drafts, invitation keys, node_modules, caches, downloads, audit history, and local test projects are excluded. The builder uses an allowlist rather than archiving the whole workspace.
|
|
17
|
+
|
|
18
|
+
## Public repository or release upload
|
|
19
|
+
|
|
20
|
+
Upload the checked source archive and its SHA-256 file to the repository/release destination chosen by the owner. A public upload requires the target repository/service and authorized access. A local archive does not itself create a public internet URL. No remote destination is assumed by this project.
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Publishing Pocket Editor on PyPI
|
|
2
|
+
|
|
3
|
+
PyPI package: `pocket-editor` · version: `2026.11.18` · owner account: `somidouth`.
|
|
4
|
+
|
|
5
|
+
The project owner has left the license undecided. No license grant is added by this package.
|
|
6
|
+
|
|
7
|
+
## One-time account setup
|
|
8
|
+
|
|
9
|
+
Create and verify your PyPI account and enable two-factor authentication. While signed in, open https://pypi.org/manage/account/publishing/ and add a pending GitHub publisher with these exact values:
|
|
10
|
+
|
|
11
|
+
| Field | Value |
|
|
12
|
+
| --- | --- |
|
|
13
|
+
| PyPI project name | `pocket-editor` |
|
|
14
|
+
| GitHub owner | `somidouth-collab` |
|
|
15
|
+
| Repository name | `pocket-editor` |
|
|
16
|
+
| Workflow filename | `publish-pypi.yml` |
|
|
17
|
+
| Environment name | `pypi` |
|
|
18
|
+
|
|
19
|
+
No PyPI password or API token belongs in the repository or chat. This workflow uses PyPI Trusted Publishing through GitHub OIDC. The first successful upload creates the PyPI project in the account that registered the pending publisher; creating a pending publisher does not reserve the package name.
|
|
20
|
+
|
|
21
|
+
## Build and verify
|
|
22
|
+
|
|
23
|
+
Install `build` and `twine` in a dedicated virtual environment, then run:
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
python -B -m unittest -v test_release test_pypi
|
|
27
|
+
python -B tools/build_pypi.py
|
|
28
|
+
python -m twine check --strict dist/pypi/*
|
|
29
|
+
python -B tools/check_pypi.py dist/pypi
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
The builder stages only curated source files, then uses setuptools to build a wheel and a self-contained source distribution. It bundles plugins, offline help, optional backend source, and optional PHP dependency manifests. Personal settings, session backups, invitations, node_modules, and tests are excluded from the installed application payload. The standalone source distribution can be rebuilt with `python -m build` after extraction.
|
|
33
|
+
|
|
34
|
+
## Publish from GitHub
|
|
35
|
+
|
|
36
|
+
Open Actions → Build and publish PyPI package → Run workflow. Leave Publish unchecked for a build-only check. After the pending publisher is configured, run it with Publish checked on the main branch. The `pypi` GitHub environment must exist and match the PyPI configuration. Only the publish job receives permission to request an OIDC token.
|
|
37
|
+
|
|
38
|
+
PyPI does not permit replacing previously uploaded files. Increment the version in both `packaging/pyproject.toml` and `packaging/pocket_editor_app/__init__.py` for subsequent releases. Update the runtime-path example in `packaging/README.md` as well.
|