protonfs 0.1.dev43__tar.gz → 0.3.0__tar.gz

protonfs-0.3.0/.github/badges/coverage.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="114" height="20" role="img" aria-label="coverage: 82.23%"><title>coverage: 82.23%</title><filter id="blur"><feGaussianBlur stdDeviation="16"/></filter><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="114" height="20" rx="3"/></clipPath><g clip-path="url(#r)"><rect width="61" height="20" fill="#555"/><rect x="61" width="53" height="20" fill="#67ac09"/><rect width="114" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><g transform="scale(.1)"><g aria-hidden="true" fill="#010101"><text x="315" y="150" fill-opacity=".8" filter="url(#blur)" textLength="510">coverage</text><text x="315" y="150" fill-opacity=".3" textLength="510">coverage</text></g><text x="315" y="140" textLength="510">coverage</text></g><g transform="scale(.1)"><g aria-hidden="true" fill="#010101"><text x="865" y="150" fill-opacity=".8" filter="url(#blur)" textLength="430">82.23%</text><text x="865" y="150" fill-opacity=".3" textLength="430">82.23%</text></g><text x="865" y="140" textLength="430">82.23%</text></g></g></svg>

protonfs-0.3.0/.github/badges/interrogate-badge.svg

@@ -0,0 +1,58 @@
+<svg width="140" height="20" viewBox="0 0 140 20" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
+    <title>interrogate: 30.8%</title>
+    <g transform="matrix(1,0,0,1,22,0)">
+        <g id="backgrounds" transform="matrix(1.32789,0,0,1,-22.3892,0)">
+            <rect x="0" y="0" width="71" height="20" style="fill:rgb(85,85,85);"/>
+        </g>
+        <rect x="71" y="0" width="47" height="20" data-interrogate="color" style="fill:#e05d44"/>
+        <g transform="matrix(1.19746,0,0,1,-22.3744,-4.85723e-16)">
+            <rect x="0" y="0" width="118" height="20" style="fill:url(#_Linear1);"/>
+        </g>
+    </g>
+    <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110">
+        <text x="590" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="610">interrogate</text>
+        <text x="590" y="140" transform="scale(.1)" textLength="610">interrogate</text>
+        <text x="1160" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="370" data-interrogate="result">30.8%</text>
+        <text x="1160" y="140" transform="scale(.1)" textLength="370" data-interrogate="result">30.8%</text>
+    </g>
+    <g id="logo-shadow" serif:id="logo shadow" transform="matrix(0.854876,0,0,0.854876,-6.73514,1.732)">
+        <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+            <path d="M50,64.25C52.76,64.25 55,61.13 55,59.75C55,58.37 52.76,57.25 50,57.25C47.24,57.25 45,58.37 45,59.75C45,61.13 47.24,64.25 50,64.25Z" style="fill:rgb(1,1,1);fill-opacity:0.3;fill-rule:nonzero;"/>
+        </g>
+        <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+            <path d="M88,49.05C86.506,43.475 83.018,38.638 78.2,35.46C72.969,32.002 66.539,30.844 60.43,32.26C56.576,33.145 52.995,34.958 50,37.54C46.998,34.958 43.411,33.149 39.55,32.27C33.441,30.853 27.011,32.011 21.78,35.47C16.97,38.652 13.489,43.489 12,49.06L12,49.13C11.82,49.79 11.66,50.46 11.53,51.13C11.146,53.207 11.021,55.323 11.16,57.43C11.16,58.03 11.26,58.63 11.34,59.23C11.34,59.51 11.43,59.79 11.48,60.07C11.53,60.35 11.58,60.68 11.64,60.98C11.7,61.28 11.8,61.69 11.89,62.05C11.98,62.41 11.99,62.47 12.05,62.68C12.16,63.07 12.28,63.46 12.41,63.84L12.58,64.34C12.72,64.74 12.88,65.14 13.04,65.53L13.23,65.98C13.403,66.373 13.583,66.767 13.77,67.16L13.99,67.59C14.19,67.97 14.39,68.35 14.61,68.73L14.87,69.15C15.1,69.52 15.33,69.89 15.58,70.26L15.58,70.32L15.99,70.93C16.14,71.14 16.29,71.36 16.45,71.57C20.206,75.83 25.086,78.95 30.53,80.57C36.839,82.48 43.41,83.385 50,83.25C56.599,83.374 63.177,82.456 69.49,80.53C74.644,78.978 79.303,76.102 83,72.19C83.34,71.78 83.65,71.35 84,70.92L84.18,70.66L84.33,70.44L84.41,70.32C84.55,70.12 84.67,69.9 84.81,69.7C85.07,69.3 85.32,68.89 85.55,68.48C85.78,68.07 86.02,67.65 86.23,67.22C86.31,67.05 86.39,66.88 86.47,66.7C86.67,66.28 86.85,65.87 87.03,65.44L87.23,64.92C87.397,64.487 87.55,64.05 87.69,63.61L87.85,63.09C87.98,62.64 88.1,62.19 88.21,61.74C88.21,61.57 88.3,61.39 88.33,61.22C88.43,60.75 88.52,60.22 88.6,59.79C88.6,59.64 88.66,59.49 88.68,59.33C88.77,58.71 88.84,58.08 88.88,57.45L88.88,54.17C88.817,53.164 88.693,52.162 88.51,51.17C88.38,50.5 88.23,49.84 88.05,49.17L88,49.05ZM85.89,56.44L85.89,57.23C85.89,57.78 85.79,58.32 85.72,58.86C85.72,59.01 85.72,59.15 85.65,59.3C85.59,59.7 85.51,60.11 85.43,60.51L85.32,60.99C85.23,61.38 85.12,61.77 85.01,62.16C85.01,62.31 84.93,62.46 84.88,62.6C84.74,63.04 84.59,63.47 84.42,63.9L84.27,64.28C84.1,64.71 83.91,65.14 83.71,65.56C83.51,65.98 83.43,66.12 83.28,66.4L83.01,66.91C82.83,67.223 82.643,67.537 82.45,67.85L82.35,68.01C79.121,68.047 75.918,67.434 72.93,66.21C64.27,62.74 59,55.52 61.18,50.11C62.18,47.6 64.7,45.82 68.26,45.11C72.489,44.395 76.835,44.908 80.78,46.59C82.141,47.144 83.453,47.813 84.7,48.59C84.76,48.76 84.82,48.93 84.88,49.1C84.94,49.27 85.05,49.63 85.12,49.9C85.28,50.5 85.44,51.1 85.55,51.73C85.691,52.507 85.792,53.292 85.85,54.08L85.85,55.89C85.85,56.12 85.91,56.25 85.91,56.45L85.89,56.44ZM17.66,68C16.668,66.435 15.869,64.756 15.28,63L15.17,62.68C15.06,62.35 14.96,62.01 14.87,61.68C14.823,61.493 14.777,61.31 14.73,61.13C14.66,60.84 14.59,60.55 14.53,60.27C14.47,59.99 14.43,59.72 14.38,59.44C14.33,59.16 14.3,59 14.27,58.78C14.2,58.27 14.15,57.78 14.11,57.23L14.11,57.03C14.008,55.236 14.122,53.437 14.45,51.67C14.56,51.06 14.71,50.46 14.88,49.87C14.96,49.59 15.04,49.32 15.13,49.05C15.22,48.78 15.24,48.72 15.3,48.55C16.548,47.774 17.859,47.105 19.22,46.55C27.86,43.09 36.65,44.67 38.82,50.08C40.99,55.49 35.73,62.74 27.09,66.2C24.101,67.431 20.893,68.043 17.66,68ZM68.57,77.68C62.554,79.508 56.287,80.376 50,80.25C43.737,80.37 37.495,79.506 31.5,77.69C27.185,76.38 23.243,74.062 20,70.93C22.815,70.706 25.58,70.055 28.2,69C38.37,64.92 44.39,56 41.6,49C38.81,42 28.27,39.72 18.1,43.8L17.43,44.09C18.973,41.648 21.019,39.561 23.43,37.97C26.671,35.824 30.473,34.68 34.36,34.68C35.884,34.681 37.404,34.852 38.89,35.19C42.694,36.049 46.191,37.935 49,40.64L50,41.64L51,40.64C53.797,37.937 57.279,36.049 61.07,35.18C66.402,33.947 72.014,34.968 76.57,38C78.98,39.588 81.026,41.671 82.57,44.11L81.9,43.82C77.409,41.921 72.464,41.355 67.66,42.19C63.08,43.12 59.79,45.54 58.39,49.02C55.6,55.97 61.62,64.94 71.79,69.02C74.414,70.07 77.182,70.714 80,70.93C76.776,74.05 72.859,76.363 68.57,77.68Z" style="fill:rgb(1,1,1);fill-opacity:0.3;fill-rule:nonzero;"/>
+        </g>
+        <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+            <circle cx="71.33" cy="56" r="5.16" style="fill:rgb(1,1,1);fill-opacity:0.3;"/>
+        </g>
+        <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+            <circle cx="28.67" cy="56" r="5.16" style="fill:rgb(1,1,1);fill-opacity:0.3;"/>
+        </g>
+        <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+            <path d="M58,66C55.912,68.161 53.003,69.339 50,69.24C46.997,69.339 44.088,68.161 42,66C41.714,65.677 41.302,65.491 40.87,65.491C40.042,65.491 39.361,66.172 39.361,67C39.361,67.368 39.496,67.724 39.74,68C42.403,70.804 46.134,72.35 50,72.25C53.862,72.347 57.59,70.802 60.25,68C60.495,67.725 60.63,67.369 60.63,67C60.63,66.174 59.951,65.495 59.125,65.495C58.695,65.495 58.285,65.679 58,66Z" style="fill:rgb(1,1,1);fill-opacity:0.3;fill-rule:nonzero;"/>
+        </g>
+    </g>
+    <g id="logo-pink" serif:id="logo pink" transform="matrix(0.854876,0,0,0.854876,-6.73514,0.877124)">
+        <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+            <path d="M50,64.25C52.76,64.25 55,61.13 55,59.75C55,58.37 52.76,57.25 50,57.25C47.24,57.25 45,58.37 45,59.75C45,61.13 47.24,64.25 50,64.25Z" style="fill:rgb(222,120,160);fill-rule:nonzero;"/>
+        </g>
+        <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+            <path d="M88,49.05C86.506,43.475 83.018,38.638 78.2,35.46C72.969,32.002 66.539,30.844 60.43,32.26C56.576,33.145 52.995,34.958 50,37.54C46.998,34.958 43.411,33.149 39.55,32.27C33.441,30.853 27.011,32.011 21.78,35.47C16.97,38.652 13.489,43.489 12,49.06L12,49.13C11.82,49.79 11.66,50.46 11.53,51.13C11.146,53.207 11.021,55.323 11.16,57.43C11.16,58.03 11.26,58.63 11.34,59.23C11.34,59.51 11.43,59.79 11.48,60.07C11.53,60.35 11.58,60.68 11.64,60.98C11.7,61.28 11.8,61.69 11.89,62.05C11.98,62.41 11.99,62.47 12.05,62.68C12.16,63.07 12.28,63.46 12.41,63.84L12.58,64.34C12.72,64.74 12.88,65.14 13.04,65.53L13.23,65.98C13.403,66.373 13.583,66.767 13.77,67.16L13.99,67.59C14.19,67.97 14.39,68.35 14.61,68.73L14.87,69.15C15.1,69.52 15.33,69.89 15.58,70.26L15.58,70.32L15.99,70.93C16.14,71.14 16.29,71.36 16.45,71.57C20.206,75.83 25.086,78.95 30.53,80.57C36.839,82.48 43.41,83.385 50,83.25C56.599,83.374 63.177,82.456 69.49,80.53C74.644,78.978 79.303,76.102 83,72.19C83.34,71.78 83.65,71.35 84,70.92L84.18,70.66L84.33,70.44L84.41,70.32C84.55,70.12 84.67,69.9 84.81,69.7C85.07,69.3 85.32,68.89 85.55,68.48C85.78,68.07 86.02,67.65 86.23,67.22C86.31,67.05 86.39,66.88 86.47,66.7C86.67,66.28 86.85,65.87 87.03,65.44L87.23,64.92C87.397,64.487 87.55,64.05 87.69,63.61L87.85,63.09C87.98,62.64 88.1,62.19 88.21,61.74C88.21,61.57 88.3,61.39 88.33,61.22C88.43,60.75 88.52,60.22 88.6,59.79C88.6,59.64 88.66,59.49 88.68,59.33C88.77,58.71 88.84,58.08 88.88,57.45L88.88,54.17C88.817,53.164 88.693,52.162 88.51,51.17C88.38,50.5 88.23,49.84 88.05,49.17L88,49.05ZM85.89,56.44L85.89,57.23C85.89,57.78 85.79,58.32 85.72,58.86C85.72,59.01 85.72,59.15 85.65,59.3C85.59,59.7 85.51,60.11 85.43,60.51L85.32,60.99C85.23,61.38 85.12,61.77 85.01,62.16C85.01,62.31 84.93,62.46 84.88,62.6C84.74,63.04 84.59,63.47 84.42,63.9L84.27,64.28C84.1,64.71 83.91,65.14 83.71,65.56C83.51,65.98 83.43,66.12 83.28,66.4L83.01,66.91C82.83,67.223 82.643,67.537 82.45,67.85L82.35,68.01C79.121,68.047 75.918,67.434 72.93,66.21C64.27,62.74 59,55.52 61.18,50.11C62.18,47.6 64.7,45.82 68.26,45.11C72.489,44.395 76.835,44.908 80.78,46.59C82.141,47.144 83.453,47.813 84.7,48.59C84.76,48.76 84.82,48.93 84.88,49.1C84.94,49.27 85.05,49.63 85.12,49.9C85.28,50.5 85.44,51.1 85.55,51.73C85.691,52.507 85.792,53.292 85.85,54.08L85.85,55.89C85.85,56.12 85.91,56.25 85.91,56.45L85.89,56.44ZM17.66,68C16.668,66.435 15.869,64.756 15.28,63L15.17,62.68C15.06,62.35 14.96,62.01 14.87,61.68C14.823,61.493 14.777,61.31 14.73,61.13C14.66,60.84 14.59,60.55 14.53,60.27C14.47,59.99 14.43,59.72 14.38,59.44C14.33,59.16 14.3,59 14.27,58.78C14.2,58.27 14.15,57.78 14.11,57.23L14.11,57.03C14.008,55.236 14.122,53.437 14.45,51.67C14.56,51.06 14.71,50.46 14.88,49.87C14.96,49.59 15.04,49.32 15.13,49.05C15.22,48.78 15.24,48.72 15.3,48.55C16.548,47.774 17.859,47.105 19.22,46.55C27.86,43.09 36.65,44.67 38.82,50.08C40.99,55.49 35.73,62.74 27.09,66.2C24.101,67.431 20.893,68.043 17.66,68ZM68.57,77.68C62.554,79.508 56.287,80.376 50,80.25C43.737,80.37 37.495,79.506 31.5,77.69C27.185,76.38 23.243,74.062 20,70.93C22.815,70.706 25.58,70.055 28.2,69C38.37,64.92 44.39,56 41.6,49C38.81,42 28.27,39.72 18.1,43.8L17.43,44.09C18.973,41.648 21.019,39.561 23.43,37.97C26.671,35.824 30.473,34.68 34.36,34.68C35.884,34.681 37.404,34.852 38.89,35.19C42.694,36.049 46.191,37.935 49,40.64L50,41.64L51,40.64C53.797,37.937 57.279,36.049 61.07,35.18C66.402,33.947 72.014,34.968 76.57,38C78.98,39.588 81.026,41.671 82.57,44.11L81.9,43.82C77.409,41.921 72.464,41.355 67.66,42.19C63.08,43.12 59.79,45.54 58.39,49.02C55.6,55.97 61.62,64.94 71.79,69.02C74.414,70.07 77.182,70.714 80,70.93C76.776,74.05 72.859,76.363 68.57,77.68Z" style="fill:rgb(222,120,160);fill-rule:nonzero;"/>
+        </g>
+        <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+            <circle cx="71.33" cy="56" r="5.16" style="fill:rgb(222,120,160);"/>
+        </g>
+        <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+            <circle cx="28.67" cy="56" r="5.16" style="fill:rgb(222,120,160);"/>
+        </g>
+        <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+            <path d="M58,66C55.912,68.161 53.003,69.339 50,69.24C46.997,69.339 44.088,68.161 42,66C41.714,65.677 41.302,65.491 40.87,65.491C40.042,65.491 39.361,66.172 39.361,67C39.361,67.368 39.496,67.724 39.74,68C42.403,70.804 46.134,72.35 50,72.25C53.862,72.347 57.59,70.802 60.25,68C60.495,67.725 60.63,67.369 60.63,67C60.63,66.174 59.951,65.495 59.125,65.495C58.695,65.495 58.285,65.679 58,66Z" style="fill:rgb(222,120,160);fill-rule:nonzero;"/>
+        </g>
+    </g>
+    <defs>
+        <linearGradient id="_Linear1" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(1.22465e-15,20,-20,1.22465e-15,0,0)">
+            <stop offset="0" style="stop-color:rgb(187,187,187);stop-opacity:0.1"/>
+            <stop offset="1" style="stop-color:black;stop-opacity:0.1"/>
+        </linearGradient>
+    </defs>
+</svg>

protonfs-0.3.0/.github/workflows/ci.yml

@@ -0,0 +1,92 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  # Test across the supported Python versions. No badge/commit side effects here —
+  # this job runs 5x in the matrix and must stay side-effect-free.
+  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
+
+      - 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 --output-format=github
+        continue-on-error: true
+
+      - name: Test with coverage (+ junit)
+        run: >
+          pytest -q
+          --cov=src/protonfs --cov-report=term-missing --cov-report=xml:coverage.xml
+          --junitxml=junit.xml -o junit_family=legacy
+        continue-on-error: true
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: will-roscoe/protonfs
+          flags: py${{ matrix.python-version }}
+
+      - name: Upload test results to Codecov
+        if: ${{ !cancelled() }}
+        uses: codecov/test-results-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          flags: py${{ matrix.python-version }}
+
+  # Regenerate and commit the committed SVG badges ONCE, from a single canonical
+  # Python version, only on a push to main. Split out of the matrix so the badge is
+  # deterministic and the git push does not race across five parallel jobs.
+  badges:
+    needs: test
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    concurrency:
+      group: badges-${{ github.ref }}
+      cancel-in-progress: false
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install package with dev dependencies
+        run: pip install -e .[dev]
+
+      - name: Coverage (single canonical run)
+        run: pytest -q --cov=src/protonfs --cov-report=xml:coverage.xml
+        continue-on-error: true
+
+      - name: Generate badges
+        run: |
+          mkdir -p .github/badges
+          genbadge coverage -i coverage.xml -o .github/badges/coverage.svg
+          interrogate src/protonfs/ -g .github/badges/interrogate-badge.svg || true
+
+      - name: Commit updated badges
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add .github/badges/coverage.svg .github/badges/interrogate-badge.svg
+          git diff --cached --quiet || git commit -m "chore: update CI badges [skip ci]"
+          git push

protonfs-0.3.0/.github/workflows/version-badge.yml

@@ -0,0 +1,53 @@
+name: "Update Version Badge"
+on:
+  # The version comes from git tags (hatch-vcs), not pyproject.toml, so update the
+  # badge when a release tag is pushed — and allow a manual run.
+  push:
+    tags:
+      - 'v*'
+  workflow_dispatch:
+
+jobs:
+  regenerate-version-badge:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    concurrency:
+      group: version-badge
+      cancel-in-progress: false
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: main            # commit the badge to main even when triggered by a tag push
+          fetch-depth: 0       # full history for the version tags
+          fetch-tags: true     # fetch-depth:0 alone does not guarantee tags in checkout@v4
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Resolve version and regenerate badge
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          # Read the release version from the newest v* tag by version order (does
+          # not depend on the tag being an ancestor of HEAD, unlike git describe).
+          # pyproject.toml has no static version under hatch-vcs, so it can't be grepped.
+          git fetch --tags --force --quiet
+          VERSION=$(git tag --list 'v[0-9]*' --sort=-version:refname | head -n1 | sed 's/^v//')
+          if [ -z "$VERSION" ]; then
+            echo "No v* release tag on the remote yet — nothing to badge; skipping."
+            exit 0
+          fi
+          echo "version: $VERSION"
+          # shields.io message escaping: '-' -> '--', '_' -> '__'.
+          BADGE_VERSION=$(printf '%s' "$VERSION" | sed 's/-/--/g; s/_/__/g')
+
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
+
+          mkdir -p .github/badges
+          curl -fsS -o .github/badges/version.svg \
+            "https://img.shields.io/badge/version-${BADGE_VERSION}-blue?style=flat"
+
+          git add .github/badges/version.svg
+          git diff --cached --quiet || git commit -m "chore: update version badge [skip ci]"
+          git push origin HEAD:main

{protonfs-0.1.dev43 → protonfs-0.3.0}/PKG-INFO

@@ -1,10 +1,11 @@
 Metadata-Version: 2.4
 Name: protonfs
-Version: 0.1.dev43
+Version: 0.3.0
 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
+Project-URL: Documentation, https://will-roscoe.github.io/protonfs/
+Author-email: Will Roscoe <protonfs.git@willroscoe.uk>
 License: PolyForm Noncommercial License 1.0.0
         
         <https://polyformproject.org/licenses/noncommercial/1.0.0>
@@ -149,6 +150,10 @@ Requires-Dist: click>=8.1
 Requires-Dist: pathspec>=0.12
 Requires-Dist: rich>=13.0
 Provides-Extra: dev
+Requires-Dist: genbadge[coverage]>=1.1; extra == 'dev'
+Requires-Dist: interrogate>=1.7; extra == 'dev'
+Requires-Dist: pre-commit>=3; extra == 'dev'
+Requires-Dist: pytest-cov>=5; extra == 'dev'
 Requires-Dist: pytest>=8.0; extra == 'dev'
 Requires-Dist: ruff>=0.6; extra == 'dev'
 Provides-Extra: docs
@@ -192,6 +197,41 @@ protonfs auth login        # opens a URL to authenticate (passthrough to proton-
 SHA-512 does not match the pinned checksum. Override the version with
 `PROTONFS_DRIVE_VERSION` and the expected checksum with `PROTONFS_DRIVE_SHA512`.
 
+## Headless Linux (SSH, no desktop)
+
+`proton-drive` keeps its session in the OS keyring, which on Linux means the
+freedesktop Secret Service reached over the D-Bus **session bus**. An SSH login
+has neither, which produces two failures that look like bugs in Proton Drive but
+are really a missing environment:
+
+```
+Cannot autolaunch D-Bus without X11 $DISPLAY          # no session bus at all
+Cannot create an item in a locked collection          # bus exists; the keyring is sealed
+```
+
+The second one is the nastier of the two: if the machine has ever had a graphical
+login, `~/.local/share/keyrings/login.keyring` exists, is the *default* collection,
+and is locked with a password you cannot type over SSH — so `auth login` completes
+the whole browser flow and only then fails to save the session.
+
+protonfs handles both for you. Every command that shells out to `proton-drive`
+first reuses (or starts, and caches) a session bus, and runs `gnome-keyring-daemon`
+against a protonfs-owned keyring directory so it never has to unlock the sealed
+system keyring. To check a host:
+
+```bash
+protonfs doctor          # binary, session bus, Secret Service, and a real keyring write test
+protonfs doctor --fix    # ...and repair what it can
+```
+
+Requires `dbus-launch`, `gnome-keyring-daemon` and `gdbus` (packages `dbus`/`dbus-x11`,
+`gnome-keyring`, `glib2`). No root needed. To run the `proton-drive` binary by hand in
+the same environment, use `eval "$(protonfs shell-init)"`.
+
+Escape hatches: `PROTONFS_KEYRING_PASSWORD` supplies your own keyring password
+instead of the generated one, and `PROTONFS_NO_KEYRING_BOOTSTRAP=1` turns all of
+this off if you'd rather manage the environment yourself.
+
 ## License
 
 [PolyForm Noncommercial 1.0.0](LICENSE) — free for noncommercial use with

protonfs-0.3.0/README.md

@@ -0,0 +1,72 @@
+# 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`.
+
+## Headless Linux (SSH, no desktop)
+
+`proton-drive` keeps its session in the OS keyring, which on Linux means the
+freedesktop Secret Service reached over the D-Bus **session bus**. An SSH login
+has neither, which produces two failures that look like bugs in Proton Drive but
+are really a missing environment:
+
+```
+Cannot autolaunch D-Bus without X11 $DISPLAY          # no session bus at all
+Cannot create an item in a locked collection          # bus exists; the keyring is sealed
+```
+
+The second one is the nastier of the two: if the machine has ever had a graphical
+login, `~/.local/share/keyrings/login.keyring` exists, is the *default* collection,
+and is locked with a password you cannot type over SSH — so `auth login` completes
+the whole browser flow and only then fails to save the session.
+
+protonfs handles both for you. Every command that shells out to `proton-drive`
+first reuses (or starts, and caches) a session bus, and runs `gnome-keyring-daemon`
+against a protonfs-owned keyring directory so it never has to unlock the sealed
+system keyring. To check a host:
+
+```bash
+protonfs doctor          # binary, session bus, Secret Service, and a real keyring write test
+protonfs doctor --fix    # ...and repair what it can
+```
+
+Requires `dbus-launch`, `gnome-keyring-daemon` and `gdbus` (packages `dbus`/`dbus-x11`,
+`gnome-keyring`, `glib2`). No root needed. To run the `proton-drive` binary by hand in
+the same environment, use `eval "$(protonfs shell-init)"`.
+
+Escape hatches: `PROTONFS_KEYRING_PASSWORD` supplies your own keyring password
+instead of the generated one, and `PROTONFS_NO_KEYRING_BOOTSTRAP=1` turns all of
+this off if you'd rather manage the environment yourself.
+
+## License
+
+[PolyForm Noncommercial 1.0.0](LICENSE) — free for noncommercial use with
+attribution; contact the author for commercial use.

protonfs-0.3.0/docs/getting-started/index.rst

@@ -0,0 +1,35 @@
+Getting Started
+===============
+
+.. contents:: Contents
+   :local:
+   :depth: 1
+
+Installation
+------------
+
+.. code-block:: bash
+
+   pip install protonfs
+
+
+Post Installation Setup
+-----------------------
+`protonfs` also requires the `proton-drive <https://proton.me/download/drive/cli/index.html>`_
+CLI. The latest compatible version can be installed via 
+
+.. code-block:: bash
+   protonfs install-drive
+   
+Alternatively you can supply the binary yourself by passing it via `PROTONFS_DRIVE_BIN` env variable, or ensuring it is added to `PATH`.
+
+You should then log in to proton drive if you have not already done so.
+Follow the standard proton-drive auth instructions or login interactively using :code:`protonfs auth login`.
+
+.. Quick Start
+.. -----------
+
+
+.. Configuration
+.. -------------
+

protonfs-0.3.0/docs/getting-started/syncing.rst

@@ -0,0 +1,93 @@
+Syncing across machines
+=======================
+
+.. contents:: Contents
+   :local:
+   :depth: 1
+
+protonfs is designed so several machines can sync the same directory tree to the
+same Proton Drive location. This page describes that workflow and the pitfalls
+worth knowing.
+
+The sync contract
+-----------------
+
+A protonfs-managed directory keeps its state in ``.protonfs/``:
+
+- ``config.json`` — the **remote root** and defaults. Shared: commit it so every
+  clone syncs to the same place.
+- ``ignore`` — which files are in scope (gitignore syntax). Shared: commit it so
+  every clone syncs the same set.
+- ``index.json`` — this machine's record of what it has uploaded (local hashes,
+  mtimes, remote paths). **Local only** — gitignore it; it is rebuilt per device
+  and would only cause churn and false conflicts if shared.
+
+A ready-made ``.protonfs/.gitignore`` that ignores ``index.json`` while keeping
+``config.json`` and ``ignore`` tracked makes this split correct by default. If
+the managed directory lives inside a git-LFS repo, also add a
+``.protonfs/.gitattributes`` exempting these small control files from LFS, so a
+clone without an LFS pull gets the real config rather than pointer stubs.
+
+First-time setup on a client
+----------------------------
+
+.. code-block:: bash
+
+   cd <managed-dir>
+   git pull                 # get the shared contract (.protonfs/config.json + ignore)
+   protonfs doctor          # verify the proton-drive binary + OS keyring (add --fix if headless)
+   protonfs auth login      # only if not already authenticated
+   protonfs refresh         # learn what is already on Drive -> seeds THIS machine's index
+
+``refresh`` is the key cross-client primitive: metadata-only, no download, it
+makes a fresh machine aware of everything already on Drive so it will not
+re-upload what another client already sent.
+
+Uploading data
+--------------
+
+.. code-block:: bash
+
+   protonfs status                          # what is local-only vs synced
+   protonfs push <subpath> --resolve replace  # a subtree
+   protonfs push --resolve replace            # everything in scope that is new
+
+.. important::
+
+   Prefer ``--resolve replace`` (or another strategy) over a bare ``push``. With
+   no strategy, ``proton-drive`` falls back to an interactive conflict prompt;
+   when its output is captured (which protonfs always does) or the run is
+   headless, that prompt auto-fails per file and those files are skipped — while
+   the run may still report them as transferred. A strategy makes uploads
+   non-interactive and idempotent.
+
+Verifying an upload
+-------------------
+
+``proton-drive`` can under-deliver silently, so confirm the delivered count
+against local before relying on an upload (for example, before deleting local
+copies to reclaim space):
+
+.. code-block:: bash
+
+   eval "$(protonfs shell-init)"     # put proton-drive on PATH with the keyring env
+   remote=$(proton-drive filesystem list <remote-root>/<subpath> --json \
+            | grep -c '"type":"file"')
+   local=$(find <subpath> -type f | wc -l)
+   echo "remote=$remote local=$local"
+   # if short, re-push (replace makes it idempotent):
+   protonfs push <subpath> --resolve replace
+
+Keeping clients in sync
+-----------------------
+
+The standard loop on any client:
+
+.. code-block:: bash
+
+   git pull                          # shared contract
+   protonfs refresh                  # reconcile local index with Drive
+                                     #   (--prune drops entries for files deleted on Drive)
+   protonfs status                   # local-only / remote-only / synced / conflict
+   protonfs push --resolve replace   # send local-only up
+   protonfs pull --refresh           # bring remote-only down (if this machine wants them)

{protonfs-0.1.dev43 → protonfs-0.3.0}/docs/index.rst

@@ -8,4 +8,5 @@ and a local sync manifest.
    :maxdepth: 1
 
    getting-started/index
+   getting-started/syncing
    api/index

{protonfs-0.1.dev43 → protonfs-0.3.0}/pyproject.toml

@@ -7,7 +7,7 @@ name = "protonfs"
 description = "Sync a local directory tree with Proton Drive via the official Proton Drive CLI, with conflict-aware push/pull and a local sync manifest."
 readme = "README.md"
 license = { file = "LICENSE" }
-authors = [{ name = "Will Roscoe" }]
+authors = [{ name = "Will Roscoe", email = "protonfs.git@willroscoe.uk" }]
 requires-python = ">=3.9"
 dynamic = ["version"]
 dependencies = [
@@ -26,6 +26,8 @@ classifiers = [
 [project.urls]
 Homepage = "https://github.com/will-roscoe/protonfs"
 Issues = "https://github.com/will-roscoe/protonfs/issues"
+Documentation = "https://will-roscoe.github.io/protonfs/"
+
 
 [project.scripts]
 protonfs = "protonfs.cli:main"
@@ -34,6 +36,10 @@ protonfs = "protonfs.cli:main"
 dev = [
     "pytest>=8.0",
     "ruff>=0.6",
+    "pytest-cov>=5",
+    "genbadge[coverage]>=1.1",
+    "interrogate>=1.7",
+    "pre-commit>=3",
 ]
 docs = [
     "sphinx",

{protonfs-0.1.dev43 → protonfs-0.3.0}/src/protonfs/cli.py

@@ -17,13 +17,17 @@ def _drive_error_boundary(func):
 
     @functools.wraps(func)
     def wrapper(*args, **kwargs):
-        from protonfs.drive import DriveAuthError, DriveError
+        from protonfs.drive import DriveAuthError, DriveError, DriveSecretsError
 
         try:
             return func(*args, **kwargs)
+        except DriveSecretsError as exc:
+            # Ordered before DriveAuthError: a keyring fault is not an auth fault, and
+            # its message already carries its own remedy (`protonfs doctor --fix`).
+            raise click.ClickException(str(exc)) from exc
         except DriveAuthError as exc:
             raise click.ClickException(
-                f"{exc}\nRun `proton-drive auth login` to re-authenticate, "
+                f"{exc}\nRun `protonfs auth login` to re-authenticate, "
                 "then retry this command."
             ) from exc
         except DriveError as exc:
@@ -196,9 +200,15 @@ def refresh(path: str | None, prune: bool) -> None:
 
 @main.command("install-drive")
 @click.option("--version", default=None, help="proton-drive version to install (default: pinned).")
-def install_drive_cmd(version: str | None) -> None:
+@click.option(
+    "--skip-keyring",
+    is_flag=True,
+    help="Do not prepare the OS keyring after installing.",
+)
+def install_drive_cmd(version: str | None, skip_keyring: bool) -> None:
     """Download and verify the official proton-drive CLI binary."""
     from protonfs.install import InstallError, install_drive
+    from protonfs.secretservice import SecretServiceError, ensure_secret_service
 
     try:
         result = install_drive(version=version)
@@ -207,9 +217,45 @@ def install_drive_cmd(version: str | None) -> None:
     click.echo(f"Installed proton-drive to {result.path} (SHA-512 verified).")
     for warning in result.warnings:
         click.echo(f"  ! {warning}")
+
+    # Prepare the keyring here, not at first login. Otherwise the failure lands after
+    # the user has completed a browser sign-in, and the session is discarded.
+    if not skip_keyring:
+        try:
+            secrets = ensure_secret_service()
+        except SecretServiceError as exc:
+            raise click.ClickException(
+                f"proton-drive is installed, but this host has no usable OS keyring "
+                f"to store its session in:\n  {exc}\n"
+                f"Run `protonfs doctor` for details."
+            ) from exc
+        for action in secrets.actions:
+            click.echo(f"  keyring: {action}")
+        for warning in secrets.warnings:
+            click.echo(f"  ! {warning}")
+
     click.echo("Next: run `protonfs auth login` to authenticate.")
 
 
+@main.command()
+@click.option("--fix", is_flag=True, help="Repair what protonfs can (bootstrap the keyring).")
+def doctor(fix: bool) -> None:
+    """Check this host can run proton-drive (binary, session bus, OS keyring)."""
+    from protonfs.commands.doctor import doctor as run
+
+    if not run(fix=fix):
+        raise click.exceptions.Exit(1)
+
+
+@main.command("shell-init")
+def shell_init() -> None:
+    """Print shell exports so `proton-drive` run by hand sees the same keyring."""
+    from protonfs.commands.doctor import shell_exports
+
+    for line in shell_exports():
+        click.echo(f"export {line}")
+
+
 @main.command()
 @click.argument("action", type=click.Choice(["login", "logout", "status"]))
 @_drive_error_boundary

{protonfs-0.1.dev43 → protonfs-0.3.0}/src/protonfs/commands/auth.py

@@ -1,10 +1,15 @@
 # src/protonfs/commands/auth.py
 """`protonfs auth {login,logout,status}` — a thin passthrough to `proton-drive auth`.
 
-Auth is left entirely to proton-drive (D3.3): it prints a URL to open on any
-device and persists the session to the OS keyring, so this works headlessly with
-no custom handling. We inherit stdio (no --json, no capture) so the interactive
-login URL reaches the user's terminal.
+Auth is left entirely to proton-drive: it prints a URL to open on any device and
+persists the session to the OS keyring. We inherit stdio (no --json, no capture) so
+the interactive login URL reaches the user's terminal.
+
+The keyring is *not* free on a headless host, though, which is why this passthrough
+bootstraps the environment first (see protonfs.secretservice). `auth login` is the
+command that writes the session, so it is exactly where a missing or locked Secret
+Service bites: the browser flow completes, and only then does the CLI die with
+`Cannot create an item in a locked collection`, having thrown the session away.
 """
 from __future__ import annotations
 
@@ -13,6 +18,7 @@ import subprocess
 from pathlib import Path
 
 from protonfs.drive import DriveError, binary_path
+from protonfs.secretservice import drive_env
 
 AUTH_SUBCOMMANDS = ("login", "logout", "status")
 
@@ -32,5 +38,5 @@ def auth_passthrough(subcommand: str, binary: str | None = None, runner=subproce
         raise DriveError(
             f"proton-drive binary not found: {bin_path}. Run `protonfs install-drive` first."
         )
-    result = runner([bin_path, "auth", subcommand])
+    result = runner([bin_path, "auth", subcommand], env=drive_env())
     return result.returncode