napari-th3-server 0.1.1.dev0__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.
@@ -0,0 +1,125 @@
1
+ Metadata-Version: 2.3
2
+ Name: napari-th3-server
3
+ Version: 0.1.1.dev0
4
+ Summary: Persistent napari display server and one-shot clients for ROOT TH3 histograms
5
+ Requires-Python: >=3.13
6
+ Description-Content-Type: text/markdown
7
+
8
+ # napari-th3-server
9
+
10
+ Persistent napari display server and one-shot clients for ROOT TH3 histograms.
11
+
12
+ ## Status: project scaffold only
13
+
14
+ Initialized with Astral `uv`, a `src/` layout, and the `uv_build` backend.
15
+ **The working TH3 implementation has not been migrated yet.** The generated
16
+ `napari-th3-server` command currently prints a greeting; it does not open a
17
+ viewer or start a server. No runtime dependencies have been added.
18
+
19
+ The intended flagship workflow is:
20
+
21
+ 1. Start the napari display server once and leave its window running.
22
+ 2. Run a client to select a TH3 from a ROOT file and display it in that window.
23
+ 3. Optionally submit a CSV event group, let the client exit, and browse the
24
+ group inside napari without loading all volumes into memory.
25
+
26
+ ## Move to the new repository
27
+
28
+ Copy this directory, not the surrounding experiment project:
29
+
30
+ ```bash
31
+ rsync -av --exclude='.venv/' --exclude='dist/' --exclude='build/' \
32
+ --exclude='__pycache__/' --exclude='.git/' \
33
+ napari-th3-server/ /path/to/new/repository/
34
+ ```
35
+
36
+ This command deliberately copies **only the scaffold**. The working source
37
+ files listed below remain in the original project. Keep that original project
38
+ available, or transfer those source files and tests separately for migration.
39
+ Do not assume that `../` will still contain them after moving this directory.
40
+
41
+ Create the new Git repository manually, as planned. No Git repository has been
42
+ initialized here, and nothing has been published to PyPI.
43
+
44
+ ## uv commands
45
+
46
+ Requires Python 3.13 or later; the development interpreter is pinned to 3.13.
47
+ A lower minimum Python version has not been tested.
48
+
49
+ ```bash
50
+ uv sync
51
+ uv run napari-th3-server # placeholder greeting ONLY, until implementation migration
52
+ uv build # builds the scaffold wheel and source distribution
53
+ ```
54
+
55
+ `uv.lock` should be retained for reproducible development. An installation of
56
+ the eventual viewer will still need working Qt/OpenGL on the display machine.
57
+
58
+ ## Implementation migration: next stage
59
+
60
+ Bring over the following files from the original working project, then adapt
61
+ them into `src/napari_th3_server/` with package-relative imports:
62
+
63
+ | Existing source | Responsibility |
64
+ |---|---|
65
+ | `napari_server.py` | Persistent TCP receiver and napari GUI |
66
+ | `th3_sender.py` | One-shot ROOT sender and CSV browsing submission |
67
+ | `remote_proto.py` | Framing, arrays, browsing manifests, acknowledgments |
68
+ | `th3_data.py` | Qt-free ROOT XYZ to napari ZYX conversion |
69
+ | `root_pager.py` | Lazy server-side shared-ROOT paging |
70
+ | `event_csv.py` | Named CSV event-column parsing |
71
+ | `view_th3.py` | Direct viewer plus existing selection/stamping utilities |
72
+ | `th3_general.py` | Optional spiral/reference-line demonstration and loop |
73
+
74
+ Also retain the regression sources: `test_event_csv.py`,
75
+ `test_remote_browse.py`, `test_scene_orientation.py`, `test_th3_loop.py`, and
76
+ `test_orientation.py`. Do not bundle ROOT data files or screenshots. Replace
77
+ regression tests that rely on the original sample ROOT file with generated
78
+ fixtures where needed.
79
+
80
+ The one-shot sender currently imports utilities through `view_th3.py`, which
81
+ pulls in GUI code. Separate those utilities before promising a GUI-free client
82
+ installation. Remove file/output defaults based on the source directory.
83
+
84
+ See **AGENTS.md** for the approved orientation convention, existing wire and
85
+ CSV behavior, security constraints, and migration acceptance checks.
86
+
87
+ ## Versioning with bumpversion
88
+
89
+ `.bumpversion.cfg` uses the `bumpversion` command supplied by **bump2version**.
90
+ `pyproject.toml` is the package version source; the config also updates the
91
+ project entry in `uv.lock` and its own `current_version`. Do not add a separate
92
+ manually maintained `version.py`.
93
+
94
+ Commit the initial project/configuration first and start each bump from a clean
95
+ Git working tree. From the initial `0.1.0`, the tested development cycle is:
96
+
97
+ ```bash
98
+ bumpversion patch # 0.1.0 -> 0.1.1.dev0
99
+ bumpversion build # 0.1.1.dev0 -> 0.1.1.dev1 (repeat as needed)
100
+ bumpversion release # 0.1.1.dev1 -> 0.1.1
101
+ uv sync # refresh installed package metadata
102
+ ```
103
+
104
+ `bumpversion minor` or `bumpversion major` starts the next minor/major cycle
105
+ at `.dev0`. Development versions use canonical Python spelling **`.devN`**, not
106
+ `-devN`, to keep project and regenerated uv lockfile versions consistent.
107
+
108
+ **Every bump automatically commits and creates a `v{version}` Git tag**, including
109
+ development builds. It does not push or publish to PyPI. Preview changes with
110
+ `bumpversion --dry-run --verbose patch` (or the part you intend to bump).
111
+ The real project is still at `0.1.0`; configuration testing did not bump it.
112
+
113
+ ## Before the first PyPI release
114
+
115
+ - Migrate and test the actual server/client workflow in the new repository.
116
+ - Decide runtime dependencies and viewer/demo extras; test clean installations.
117
+ - Choose the final command names and user-facing API.
118
+ - Confirm PyPI name availability and choose an explicit license/author metadata.
119
+ - Build and test the installed wheel, not only the source checkout.
120
+ - Configure release automation and publishing credentials in the new repository.
121
+
122
+ `napari-th3-server` is the chosen working project name, not a claim that the
123
+ name is available on PyPI. Successful scaffold builds do not validate the
124
+ future TH3 application. Publishing is intentionally a later, user-controlled
125
+ step.
@@ -0,0 +1,118 @@
1
+ # napari-th3-server
2
+
3
+ Persistent napari display server and one-shot clients for ROOT TH3 histograms.
4
+
5
+ ## Status: project scaffold only
6
+
7
+ Initialized with Astral `uv`, a `src/` layout, and the `uv_build` backend.
8
+ **The working TH3 implementation has not been migrated yet.** The generated
9
+ `napari-th3-server` command currently prints a greeting; it does not open a
10
+ viewer or start a server. No runtime dependencies have been added.
11
+
12
+ The intended flagship workflow is:
13
+
14
+ 1. Start the napari display server once and leave its window running.
15
+ 2. Run a client to select a TH3 from a ROOT file and display it in that window.
16
+ 3. Optionally submit a CSV event group, let the client exit, and browse the
17
+ group inside napari without loading all volumes into memory.
18
+
19
+ ## Move to the new repository
20
+
21
+ Copy this directory, not the surrounding experiment project:
22
+
23
+ ```bash
24
+ rsync -av --exclude='.venv/' --exclude='dist/' --exclude='build/' \
25
+ --exclude='__pycache__/' --exclude='.git/' \
26
+ napari-th3-server/ /path/to/new/repository/
27
+ ```
28
+
29
+ This command deliberately copies **only the scaffold**. The working source
30
+ files listed below remain in the original project. Keep that original project
31
+ available, or transfer those source files and tests separately for migration.
32
+ Do not assume that `../` will still contain them after moving this directory.
33
+
34
+ Create the new Git repository manually, as planned. No Git repository has been
35
+ initialized here, and nothing has been published to PyPI.
36
+
37
+ ## uv commands
38
+
39
+ Requires Python 3.13 or later; the development interpreter is pinned to 3.13.
40
+ A lower minimum Python version has not been tested.
41
+
42
+ ```bash
43
+ uv sync
44
+ uv run napari-th3-server # placeholder greeting ONLY, until implementation migration
45
+ uv build # builds the scaffold wheel and source distribution
46
+ ```
47
+
48
+ `uv.lock` should be retained for reproducible development. An installation of
49
+ the eventual viewer will still need working Qt/OpenGL on the display machine.
50
+
51
+ ## Implementation migration: next stage
52
+
53
+ Bring over the following files from the original working project, then adapt
54
+ them into `src/napari_th3_server/` with package-relative imports:
55
+
56
+ | Existing source | Responsibility |
57
+ |---|---|
58
+ | `napari_server.py` | Persistent TCP receiver and napari GUI |
59
+ | `th3_sender.py` | One-shot ROOT sender and CSV browsing submission |
60
+ | `remote_proto.py` | Framing, arrays, browsing manifests, acknowledgments |
61
+ | `th3_data.py` | Qt-free ROOT XYZ to napari ZYX conversion |
62
+ | `root_pager.py` | Lazy server-side shared-ROOT paging |
63
+ | `event_csv.py` | Named CSV event-column parsing |
64
+ | `view_th3.py` | Direct viewer plus existing selection/stamping utilities |
65
+ | `th3_general.py` | Optional spiral/reference-line demonstration and loop |
66
+
67
+ Also retain the regression sources: `test_event_csv.py`,
68
+ `test_remote_browse.py`, `test_scene_orientation.py`, `test_th3_loop.py`, and
69
+ `test_orientation.py`. Do not bundle ROOT data files or screenshots. Replace
70
+ regression tests that rely on the original sample ROOT file with generated
71
+ fixtures where needed.
72
+
73
+ The one-shot sender currently imports utilities through `view_th3.py`, which
74
+ pulls in GUI code. Separate those utilities before promising a GUI-free client
75
+ installation. Remove file/output defaults based on the source directory.
76
+
77
+ See **AGENTS.md** for the approved orientation convention, existing wire and
78
+ CSV behavior, security constraints, and migration acceptance checks.
79
+
80
+ ## Versioning with bumpversion
81
+
82
+ `.bumpversion.cfg` uses the `bumpversion` command supplied by **bump2version**.
83
+ `pyproject.toml` is the package version source; the config also updates the
84
+ project entry in `uv.lock` and its own `current_version`. Do not add a separate
85
+ manually maintained `version.py`.
86
+
87
+ Commit the initial project/configuration first and start each bump from a clean
88
+ Git working tree. From the initial `0.1.0`, the tested development cycle is:
89
+
90
+ ```bash
91
+ bumpversion patch # 0.1.0 -> 0.1.1.dev0
92
+ bumpversion build # 0.1.1.dev0 -> 0.1.1.dev1 (repeat as needed)
93
+ bumpversion release # 0.1.1.dev1 -> 0.1.1
94
+ uv sync # refresh installed package metadata
95
+ ```
96
+
97
+ `bumpversion minor` or `bumpversion major` starts the next minor/major cycle
98
+ at `.dev0`. Development versions use canonical Python spelling **`.devN`**, not
99
+ `-devN`, to keep project and regenerated uv lockfile versions consistent.
100
+
101
+ **Every bump automatically commits and creates a `v{version}` Git tag**, including
102
+ development builds. It does not push or publish to PyPI. Preview changes with
103
+ `bumpversion --dry-run --verbose patch` (or the part you intend to bump).
104
+ The real project is still at `0.1.0`; configuration testing did not bump it.
105
+
106
+ ## Before the first PyPI release
107
+
108
+ - Migrate and test the actual server/client workflow in the new repository.
109
+ - Decide runtime dependencies and viewer/demo extras; test clean installations.
110
+ - Choose the final command names and user-facing API.
111
+ - Confirm PyPI name availability and choose an explicit license/author metadata.
112
+ - Build and test the installed wheel, not only the source checkout.
113
+ - Configure release automation and publishing credentials in the new repository.
114
+
115
+ `napari-th3-server` is the chosen working project name, not a claim that the
116
+ name is available on PyPI. Successful scaffold builds do not validate the
117
+ future TH3 application. Publishing is intentionally a later, user-controlled
118
+ step.
@@ -0,0 +1,14 @@
1
+ [project]
2
+ name = "napari-th3-server"
3
+ version = "0.1.1.dev0"
4
+ description = "Persistent napari display server and one-shot clients for ROOT TH3 histograms"
5
+ readme = "README.md"
6
+ requires-python = ">=3.13"
7
+ dependencies = []
8
+
9
+ [project.scripts]
10
+ napari-th3-server = "napari_th3_server:main"
11
+
12
+ [build-system]
13
+ requires = ["uv_build>=0.9.7,<0.10.0"]
14
+ build-backend = "uv_build"
@@ -0,0 +1,2 @@
1
+ def main() -> None:
2
+ print("Hello from napari-th3-server!")