protonfs 0.1.dev43__tar.gz

protonfs-0.1.dev43/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package with dev dependencies
+        run: pip install -e .[dev]
+
+      - name: Lint
+        run: ruff check src tests
+
+      - name: Test
+        run: pytest

protonfs-0.1.dev43/.github/workflows/docs.yml

@@ -0,0 +1,67 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'docs/**'
+      - 'src/**'
+      - '.github/workflows/docs.yml'
+  workflow_dispatch:
+  workflow_call:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: pip install -e ".[docs]"
+
+      - name: Regenerate API stubs
+        run: sphinx-apidoc -f -o docs/api/protonfs/ src/protonfs/ --separate --module-first -q
+
+      - name: Build docs
+        run: sphinx-build --keep-going -b html docs/ docs/_build/html
+
+      - name: Upload built docs
+        if: github.ref == 'refs/heads/main'
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs-html
+          path: docs/_build/html/
+          retention-days: 30
+
+      - name: Upload Pages artifact
+        if: github.ref == 'refs/heads/main'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_build/html/
+
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

protonfs-0.1.dev43/.github/workflows/release.yml

@@ -0,0 +1,66 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch: 
+    
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build backend
+        run: pip install build
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4      # ← Add this
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4      # ← Add this
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create GitHub release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: gh release create "${{ github.ref_name }}" dist/* --generate-notes

protonfs-0.1.dev43/.gitignore

@@ -0,0 +1,15 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+.mypy_cache/
+docs/_build/
+.worktrees/

protonfs-0.1.dev43/LICENSE

@@ -0,0 +1,133 @@
+PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+Required Notice: Copyright Will Roscoe (https://github.com/will-roscoe)
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the
+software to do everything you might do with the software
+that would otherwise infringe the licensor's copyright
+in it for any permitted purpose. However, you may
+only distribute the software according to Distribution
+License and make changes or new works
+based on the software according to Changes and New Works
+License.
+
+## Distribution License
+
+The licensor grants you an additional copyright license
+to distribute copies of the software. Your license
+to distribute covers distributing the software with
+changes and new works permitted by Changes and New Works
+License.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of
+the software from you also gets a copy of these terms or the
+URL for them above, as well as copies of any plain-text lines
+beginning with "Required Notice:" that the licensor provided
+with the software. For example:
+
+Required Notice: Copyright Will Roscoe (https://github.com/will-roscoe)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that
+covers patent claims the licensor can license, or becomes able
+to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for
+the benefit of public knowledge, personal study, private
+entertainment, hobby projects, amateur pursuits, or religious
+observance, without any anticipated commercial application,
+is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution,
+public research organization, public safety or health
+organization, environmental protection organization,
+or government institution is use for a permitted purpose
+regardless of the source of funding or obligations resulting
+from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else. These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have
+violated any of these terms, or done anything with the software
+not covered by your licenses, your licenses can nonetheless
+continue if you come into full compliance with these terms,
+and take practical steps to correct past violations, within
+32 days of receiving notice. Otherwise, all your licenses
+end immediately.
+
+## No Liability
+
+As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.
+
+## Definitions
+
+The licensor is the individual or entity offering these
+terms, and the software is the software the licensor makes
+available under these terms.
+
+You refers to the individual or entity agreeing to these
+terms.
+
+Your company is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+organizations that have control over, are under the control of,
+or are under common control with that organization. Control
+means ownership of substantially all the assets of an entity,
+or the power to direct its management and policies by vote,
+contract, or otherwise. Control can be direct or indirect.
+
+Your licenses are all the licenses granted to you for the
+software under these terms.
+
+Use means anything you do with the software requiring one
+of your licenses.

protonfs-0.1.dev43/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: protonfs
+Version: 0.1.dev43
+Summary: Sync a local directory tree with Proton Drive via the official Proton Drive CLI, with conflict-aware push/pull and a local sync manifest.
+Project-URL: Homepage, https://github.com/will-roscoe/protonfs
+Project-URL: Issues, https://github.com/will-roscoe/protonfs/issues
+Author: Will Roscoe
+License: PolyForm Noncommercial License 1.0.0
+        
+        <https://polyformproject.org/licenses/noncommercial/1.0.0>
+        
+        Required Notice: Copyright Will Roscoe (https://github.com/will-roscoe)
+        
+        ## Acceptance
+        
+        In order to get any license under these terms, you must agree
+        to them as both strict obligations and conditions to all
+        your licenses.
+        
+        ## Copyright License
+        
+        The licensor grants you a copyright license for the
+        software to do everything you might do with the software
+        that would otherwise infringe the licensor's copyright
+        in it for any permitted purpose. However, you may
+        only distribute the software according to Distribution
+        License and make changes or new works
+        based on the software according to Changes and New Works
+        License.
+        
+        ## Distribution License
+        
+        The licensor grants you an additional copyright license
+        to distribute copies of the software. Your license
+        to distribute covers distributing the software with
+        changes and new works permitted by Changes and New Works
+        License.
+        
+        ## Notices
+        
+        You must ensure that anyone who gets a copy of any part of
+        the software from you also gets a copy of these terms or the
+        URL for them above, as well as copies of any plain-text lines
+        beginning with "Required Notice:" that the licensor provided
+        with the software. For example:
+        
+        Required Notice: Copyright Will Roscoe (https://github.com/will-roscoe)
+        
+        ## Changes and New Works License
+        
+        The licensor grants you an additional copyright license to
+        make changes and new works based on the software for any
+        permitted purpose.
+        
+        ## Patent License
+        
+        The licensor grants you a patent license for the software that
+        covers patent claims the licensor can license, or becomes able
+        to license, that you would infringe by using the software.
+        
+        ## Noncommercial Purposes
+        
+        Any noncommercial purpose is a permitted purpose.
+        
+        ## Personal Uses
+        
+        Personal use for research, experiment, and testing for
+        the benefit of public knowledge, personal study, private
+        entertainment, hobby projects, amateur pursuits, or religious
+        observance, without any anticipated commercial application,
+        is use for a permitted purpose.
+        
+        ## Noncommercial Organizations
+        
+        Use by any charitable organization, educational institution,
+        public research organization, public safety or health
+        organization, environmental protection organization,
+        or government institution is use for a permitted purpose
+        regardless of the source of funding or obligations resulting
+        from the funding.
+        
+        ## Fair Use
+        
+        You may have "fair use" rights for the software under the
+        law. These terms do not limit them.
+        
+        ## No Other Rights
+        
+        These terms do not allow you to sublicense or transfer any of
+        your licenses to anyone else, or prevent the licensor from
+        granting licenses to anyone else. These terms do not imply
+        any other licenses.
+        
+        ## Patent Defense
+        
+        If you make any written claim that the software infringes or
+        contributes to infringement of any patent, your patent license
+        for the software granted under these terms ends immediately. If
+        your company makes such a claim, your patent license ends
+        immediately for work on behalf of your company.
+        
+        ## Violations
+        
+        The first time you are notified in writing that you have
+        violated any of these terms, or done anything with the software
+        not covered by your licenses, your licenses can nonetheless
+        continue if you come into full compliance with these terms,
+        and take practical steps to correct past violations, within
+        32 days of receiving notice. Otherwise, all your licenses
+        end immediately.
+        
+        ## No Liability
+        
+        As far as the law allows, the software comes as is, without
+        any warranty or condition, and the licensor will not be liable
+        to you for any damages arising out of these terms or the use
+        or nature of the software, under any kind of legal claim.
+        
+        ## Definitions
+        
+        The licensor is the individual or entity offering these
+        terms, and the software is the software the licensor makes
+        available under these terms.
+        
+        You refers to the individual or entity agreeing to these
+        terms.
+        
+        Your company is any legal entity, sole proprietorship,
+        or other kind of organization that you work for, plus all
+        organizations that have control over, are under the control of,
+        or are under common control with that organization. Control
+        means ownership of substantially all the assets of an entity,
+        or the power to direct its management and policies by vote,
+        contract, or otherwise. Control can be direct or indirect.
+        
+        Your licenses are all the licenses granted to you for the
+        software under these terms.
+        
+        Use means anything you do with the software requiring one
+        of your licenses.
+License-File: LICENSE
+Classifier: Environment :: Console
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Requires-Dist: click>=8.1
+Requires-Dist: pathspec>=0.12
+Requires-Dist: rich>=13.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: furo; extra == 'docs'
+Requires-Dist: sphinx; extra == 'docs'
+Requires-Dist: sphinx-autobuild; extra == 'docs'
+Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
+Requires-Dist: sphinx-copybutton; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# protonfs
+
+Sync a local directory tree with [Proton Drive](https://proton.me/drive), via
+the official [Proton Drive CLI](https://github.com/ProtonDriveApps/sdk/tree/main/cli),
+with conflict-aware push/pull and a local sync manifest.
+
+Originally built to replace git-lfs as the storage layer for large,
+write-once simulation output — data that doesn't need version history, just
+somewhere durable to live and a way to fetch it back on demand.
+
+The command surface (`setup`, `status`, `ls`, `push`, `pull`, `rm`, `restore`,
+`refresh`, `install-drive`, `auth`) is implemented — see `src/protonfs/cli.py`.
+
+## Requirements
+
+- Python >= 3.9
+- The [`proton-drive`](https://proton.me/download/drive/cli/index.html) CLI
+  binary — install it with `protonfs install-drive` (below), or supply your own
+  on `PATH` / via `PROTONFS_DRIVE_BIN`.
+
+## Install
+
+```bash
+pip install protonfs
+protonfs install-drive     # downloads + SHA-512-verifies the official proton-drive binary
+protonfs auth login        # opens a URL to authenticate (passthrough to proton-drive)
+```
+
+`install-drive` detects your platform, requires AVX2 for the linux-x64 prebuilt
+(with an instructive fallback otherwise), and never installs a binary whose
+SHA-512 does not match the pinned checksum. Override the version with
+`PROTONFS_DRIVE_VERSION` and the expected checksum with `PROTONFS_DRIVE_SHA512`.
+
+## License
+
+[PolyForm Noncommercial 1.0.0](LICENSE) — free for noncommercial use with
+attribution; contact the author for commercial use.

protonfs-0.1.dev43/README.md

@@ -0,0 +1,37 @@
+# protonfs
+
+Sync a local directory tree with [Proton Drive](https://proton.me/drive), via
+the official [Proton Drive CLI](https://github.com/ProtonDriveApps/sdk/tree/main/cli),
+with conflict-aware push/pull and a local sync manifest.
+
+Originally built to replace git-lfs as the storage layer for large,
+write-once simulation output — data that doesn't need version history, just
+somewhere durable to live and a way to fetch it back on demand.
+
+The command surface (`setup`, `status`, `ls`, `push`, `pull`, `rm`, `restore`,
+`refresh`, `install-drive`, `auth`) is implemented — see `src/protonfs/cli.py`.
+
+## Requirements
+
+- Python >= 3.9
+- The [`proton-drive`](https://proton.me/download/drive/cli/index.html) CLI
+  binary — install it with `protonfs install-drive` (below), or supply your own
+  on `PATH` / via `PROTONFS_DRIVE_BIN`.
+
+## Install
+
+```bash
+pip install protonfs
+protonfs install-drive     # downloads + SHA-512-verifies the official proton-drive binary
+protonfs auth login        # opens a URL to authenticate (passthrough to proton-drive)
+```
+
+`install-drive` detects your platform, requires AVX2 for the linux-x64 prebuilt
+(with an instructive fallback otherwise), and never installs a binary whose
+SHA-512 does not match the pinned checksum. Override the version with
+`PROTONFS_DRIVE_VERSION` and the expected checksum with `PROTONFS_DRIVE_SHA512`.
+
+## License
+
+[PolyForm Noncommercial 1.0.0](LICENSE) — free for noncommercial use with
+attribution; contact the author for commercial use.

protonfs-0.1.dev43/docs/api/index.rst

@@ -0,0 +1,7 @@
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   protonfs/modules

protonfs-0.1.dev43/docs/api/protonfs/modules.rst

@@ -0,0 +1,7 @@
+protonfs
+========
+
+.. toctree::
+   :maxdepth: 4
+
+   protonfs

protonfs-0.1.dev43/docs/api/protonfs/protonfs.cli.rst

@@ -0,0 +1,7 @@
+protonfs.cli module
+===================
+
+.. automodule:: protonfs.cli
+   :members:
+   :show-inheritance:
+   :undoc-members:

protonfs-0.1.dev43/docs/api/protonfs/protonfs.rst

@@ -0,0 +1,15 @@
+protonfs package
+================
+
+.. automodule:: protonfs
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   protonfs.cli

protonfs-0.1.dev43/docs/conf.py

@@ -0,0 +1,38 @@
+# Configuration file for the Sphinx documentation builder.
+import os
+import sys
+
+# -- Path setup ---------------------------------------------------------------
+sys.path.insert(0, os.path.abspath("../src"))
+
+# -- Project information ------------------------------------------------------
+project = "protonfs"
+author = "Will Roscoe"
+copyright = "2026, Will Roscoe"
+release = ""
+
+# -- General configuration ----------------------------------------------------
+extensions = [
+    # Core
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",  # NumPy/Google docstring styles
+    # Python
+    "sphinx.ext.autodoc",
+    "sphinx_autodoc_typehints",
+    "sphinx_copybutton",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+source_suffix = ".rst"
+master_doc = "index"
+
+# -- Options for HTML output --------------------------------------------------
+html_theme = "furo"
+html_static_path = ["_static"]
+
+# -- Intersphinx --------------------------------------------------------------
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+}

protonfs-0.1.dev43/docs/getting-started/index.rst

@@ -0,0 +1,21 @@
+Getting Started
+===============
+
+.. contents:: Contents
+   :local:
+   :depth: 1
+
+Installation
+------------
+
+.. code-block:: bash
+
+   pip install protonfs
+
+Also requires the `proton-drive <https://proton.me/download/drive/cli/index.html>`_
+CLI on ``PATH``, authenticated via ``proton-drive auth login``.
+
+Quick Start
+-----------
+
+*Add a minimal usage example here once the command surface is implemented.*

protonfs-0.1.dev43/docs/index.rst

@@ -0,0 +1,11 @@
+protonfs
+========
+
+Sync a local directory tree with Proton Drive, with conflict-aware push/pull
+and a local sync manifest.
+
+.. toctree::
+   :maxdepth: 1
+
+   getting-started/index
+   api/index