fz-manager-plus 0.1.2__tar.gz

fz_manager_plus-0.1.2/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: Lint (ruff check)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - run: uv sync --group dev --locked
+      - run: uv run ruff check fz_manager_plus tests
+
+  format:
+    name: Format check (ruff format, isort)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - run: uv sync --group dev --locked
+      - run: uv run ruff format --check fz_manager_plus tests
+      - run: uv run isort --check-only fz_manager_plus tests
+
+  test:
+    name: Tests (pytest)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - run: uv sync --group dev --locked
+      - run: uv run pytest -q

fz_manager_plus-0.1.2/.github/workflows/release.yml

@@ -0,0 +1,54 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Check tag matches pyproject.toml version
+        run: |
+          tag_version="${GITHUB_REF_NAME#v}"
+          project_version="$(uv version --short)"
+          if [[ "$tag_version" != "$project_version" ]]; then
+            echo "::error::tag v$tag_version does not match pyproject.toml version $project_version"
+            exit 1
+          fi
+
+      - run: uv build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    # Configure this environment (and a PyPI "Trusted Publisher" for it) in
+    # the repository settings before the first release; see README.md.
+    environment:
+      name: pypi
+      url: https://pypi.org/project/fz-manager-plus/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: astral-sh/setup-uv@v5
+      - run: uv publish --trusted-publishing always

fz_manager_plus-0.1.2/.gitignore

@@ -0,0 +1,12 @@
+.vscode
+.idea
+.mypy_cache/
+/.coverage
+/.coverage.*
+/.nox/
+/.pytype/
+/dist/
+/docs/_build/
+/src/*.egg-info/
+__pycache__/
+.venv/

fz_manager_plus-0.1.2/.python-version

@@ -0,0 +1 @@
+3.14

fz_manager_plus-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Michel Sciortino
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fz_manager_plus-0.1.2/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.5
+Name: fz-manager-plus
+Version: 0.1.2
+Summary: Factorio Zone Server Manager
+Project-URL: repository, https://github.com/Mesheryakof/FZ-Manager-Plus
+Author-email: michelsciortino <michel.sciortino@outlook.com>, Mesheryakof <danil.spb.it@gmail.com>
+License-File: LICENSE
+Requires-Python: >=3.14
+Requires-Dist: certifi>=2021.10.8
+Requires-Dist: httpx<0.28.0,>=0.27.0
+Requires-Dist: pydantic-settings<3.0,>=2.5
+Requires-Dist: pydantic<3.0,>=2.7
+Requires-Dist: rich<15.0.0,>=14.2.0
+Requires-Dist: textual-fspicker<2.0,>=1.0.1
+Requires-Dist: textual<9.0.0,>=8.2.8
+Requires-Dist: websockets<11.0,>=10.1

fz_manager_plus-0.1.2/README.md

@@ -0,0 +1,108 @@
+# FZ-Manager Plus
+
+Terminal UI for managing a Factorio server hosted by [Factorio Zone](https://factorio.zone/), based on [FZ-Manager](https://github.com/michelsciortino/FZ-Manager).
+
+Requires Python 3.14 or newer.
+
+## Installation and launch
+
+```sh
+pip install fz-manager-plus
+fzmp
+# Equivalent:
+fz-manager-plus
+```
+
+Run `fzmp --help` to see settings and command-line options. Enter an existing Factorio Zone token, or submit an empty token to create a new account.
+
+## Available in the TUI
+
+- Start a server by choosing a region, version and save slot; stop a running server.
+- Send console commands from the log pane.
+- Upload missing ZIP mods from a folder, including nested folders, with per-file progress.
+- Enable, disable or delete mods; delete all uploaded mods after confirmation.
+- Download and delete remote save slots. Replacing an existing local archive requires confirmation.
+- Quit with `Ctrl+Q`. Background operations are cancelled and network clients are closed.
+
+Mod sync matches **filenames**, not archive contents. It uploads missing names; it does not delete remote mods or compare versions/checksums. Duplicate ZIP filenames in different local folders are reported as a conflict.
+
+The upload dialog can be cancelled before upload starts. After starting, wait for the results or quit the application. The API still supports save uploads and the project includes a mod-settings archive utility; neither has a menu action in this TUI.
+
+## Connection and operation status
+
+WebSocket connections recover automatically with delays of 1, 2, 4, 8, 16, then 30 seconds. The session logs in with its current token and refreshes server state before enabling dependent actions. Authentication failures ask for a token again.
+
+Console commands, deletions and transfers are **not replayed** on reconnect. A server may have accepted a request before the connection failed; inspect the refreshed state before repeating it.
+
+Start succeeds only after a running state and server address arrive. Default synchronization/start/stop timeouts are 60/600/3600 seconds. Adjust them with `--sync-timeout`, `--start-timeout`, `--stop-timeout` or the corresponding `FZM_*` environment variables. `--sync-batch-size` defaults to 3.
+
+The log pane and log deduplication history are limited to 10,000 entries each.
+
+## Settings
+
+Settings and the crash log are stored in:
+
+| Platform | Default directory |
+| --- | --- |
+| macOS | `~/Library/Application Support/fz-manager-plus` |
+| Linux | `$XDG_CONFIG_HOME/fz-manager-plus`, or `~/.config/fz-manager-plus` |
+| Windows | `%LOCALAPPDATA%/fz-manager-plus` |
+
+Use `--storage-dir` or `FZM_STORAGE_DIR` to override the directory. The settings file is `settings.json`; the crash log is `crash.log`.
+
+On first use of a directory without settings, the previous temporary-directory `.fzmp/settings.json` is imported if present. Its source is retained. Settings are validated before migration and written atomically; tokens are saved as soon as authentication succeeds. On POSIX systems the new settings file has mode `0600`.
+
+CLI options override environment variables; environment variables override `.env`; `.env` overrides stored settings. Existing option names, numeric save-slot preferences and `FZM_*` variables remain supported. Importing modules or assigning a settings field performs no persistence or CLI parsing.
+
+## Development
+
+```sh
+uv sync --group dev
+```
+
+### Checkers
+
+Each command only reports; none of them rewrite files. Run before pushing — this is the same set of checks GitHub Actions runs on a pull request, so a green run locally means a green PR:
+
+```sh
+uv run ruff check fz_manager_plus tests
+uv run ruff format --check fz_manager_plus tests
+uv run isort --check-only fz_manager_plus tests
+uv run pytest -q
+```
+
+Tests use fake transports and temporary directories; they do not call Factorio Zone.
+
+The composition root is `fz_manager_plus/runtime.py`. `domain` defines state and messages, `application` owns session/transfer workflows, `infrastructure` implements transports and archive utilities, and `tui` contains Textual views and user interaction. Rich styling stays at the UI boundary in `terminal.py`.
+
+### CI
+
+`.github/workflows/ci.yml` runs `lint`, `format` and `test` as separate jobs on every pull request targeting `main`. Every job fails the check instead of auto-fixing, and `uv sync --group dev --locked` also fails the job if `uv.lock` is out of date.
+
+### Releasing a new version
+
+Versions are bumped in place with [`uv version --bump`](https://docs.astral.sh/uv/concepts/projects/config/#project-version), which updates `pyproject.toml` (and re-locks `uv.lock`):
+
+```sh
+uv version --bump patch                # 0.1.1 -> 0.1.2
+uv version --bump minor                # 0.1.1 -> 0.2.0
+uv version --bump major                # 0.1.1 -> 1.0.0
+uv version --bump patch --bump dev     # 0.1.1 -> 0.1.2.dev1 (pre-release/dev build)
+```
+
+Commit the result and tag it to trigger a release:
+
+```sh
+git add pyproject.toml uv.lock
+git commit -m "chore(release): bump version to v$(uv version --short)"
+git tag "v$(uv version --short)"
+git push origin main --tags
+```
+
+Pushing a `v*` tag triggers `.github/workflows/release.yml`, which builds the sdist/wheel with `uv build`, verifies the tag matches `pyproject.toml`, and publishes to PyPI with `uv publish` using [Trusted Publishing](https://docs.pypi.org/trusted-publishers/) (no stored token). `dev` pre-releases go through the same workflow; PyPI treats them as pre-releases, installable with `pip install --pre`.
+
+One-time setup: create a `pypi` environment in the repository's GitHub settings, and register this repository/workflow/environment as a Trusted Publisher for `fz-manager-plus` on PyPI.
+
+
+## Screenshot
+![](assets/img.png?raw=true "FactorioZone Manager Plus")

fz_manager_plus-0.1.2/fz_manager_plus/__init__.py

@@ -0,0 +1,7 @@
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("fz-manager-plus")
+except PackageNotFoundError:
+    # Package is not installed (e.g. running from a source checkout without `uv sync`).
+    __version__ = "0.0.0.dev0"

fz_manager_plus-0.1.2/fz_manager_plus/application/__init__.py

@@ -0,0 +1 @@
+"""Application services, independent of the terminal UI."""

fz_manager_plus-0.1.2/fz_manager_plus/application/ports.py

@@ -0,0 +1,35 @@
+from collections.abc import AsyncIterator, Callable
+from typing import BinaryIO, Protocol
+
+from fz_manager_plus.domain.messages import BlankMessage, FzMessage, LoginResponse
+
+type Progress = Callable[[int], None] | None
+
+
+class ZoneAPI(Protocol):
+    visit_secret: str | None
+    user_token: str | None
+
+    async def login(self, reconnected: bool = False) -> LoginResponse: ...
+    async def start_instance(self, region: str, version: str, save: str) -> None: ...
+    async def stop_instance(self, launch_id: int) -> None: ...
+    async def send_command(self, launch_id: int, command: str) -> None: ...
+    async def toggle_mod(self, mod_id: int, enabled: bool) -> None: ...
+    async def delete_mod(self, mod_id: int) -> None: ...
+    async def upload_mod(
+        self, name: str, file: BinaryIO, size: int, progress: Progress = None
+    ) -> None: ...
+    async def upload_save(
+        self, name: str, file: BinaryIO, size: int, slot: str, progress: Progress = None
+    ) -> None: ...
+    async def delete_save_slot(self, slot: str) -> None: ...
+    async def download_save_slot(
+        self, slot: str, file_path: str, progress: Progress = None
+    ) -> None: ...
+    async def aclose(self) -> None: ...
+
+
+class ZoneSocket(Protocol):
+    async def connect(self) -> None: ...
+    def messages(self) -> AsyncIterator[FzMessage | BlankMessage]: ...
+    async def close(self) -> None: ...