ffl-python 0.1.4__tar.gz

ffl_python-0.1.4/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ffl_python-0.1.4/PKG-INFO

@@ -0,0 +1,210 @@
+Metadata-Version: 2.4
+Name: ffl-python
+Version: 0.1.4
+Summary: Python binding for FastFileLink, backed by the portable ffl.com APE
+Author: ffl-python contributors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/nuwainfo/ffl-python
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: PyYAML>=6.0; extra == "dev"
+Requires-Dist: setuptools>=68; extra == "dev"
+Requires-Dist: wheel>=0.42; extra == "dev"
+Dynamic: license-file
+
+# ffl-python
+
+Python binding for FastFileLink. The package bundles the portable `ffl.com` APE and
+runs it behind a Python API; callers do not need to locate or install a separate FFL
+binary.
+
+The low-level command grammar is generated by APEBind from `binding/ffl.apebind.yaml`.
+The public API in `src/ffl/client.py` is intentionally handwritten so FFL-specific
+library semantics stay explicit and reviewable.
+
+## Development
+
+```bash
+python -m venv .venv
+.venv/Scripts/python -m pip install -e ".[dev]"   # Windows
+# or: .venv/bin/python -m pip install -e ".[dev]"
+
+.\scripts\test.ps1                 # Windows
+# or: ./scripts/test.sh              # Linux/macOS
+
+.\scripts\build.ps1                # Windows
+# or: ./scripts/build.sh             # Linux/macOS
+```
+
+The test directly imports `ffl`, shares a binary file, and downloads it through the
+bundled `ffl.com` APE. It requires working network access to FastFileLink. A wheel is a
+build artifact, not the source of truth.
+
+The integration suite covers ordinary, E2EE, relay, pickup-code, and public-key
+transfers; text, bytes, folders, multiple files, QR images, hooks, explicit ports, and
+session shutdown, and Basic Auth download.
+
+## Share
+
+```python
+import ffl
+
+with ffl.share("release.zip", max_downloads=1, timeout_seconds=1800) as session:
+    print(session.link)
+```
+
+`share()` always requests a foreground FFL process and disables clipboard side effects,
+which gives library callers a deterministic `ShareSession` they can stop or keep alive.
+FFL's runtime-owned `--json` output is used internally to wait until `session.link` is
+ready.
+
+Multiple files are accepted directly:
+
+```python
+session = ffl.share(["one.txt", "two.txt"], name="files.zip")
+```
+
+Text and bytes helpers own their temporary file until the share session is closed:
+
+```python
+with ffl.share_text("hello", name="hello.txt") as session:
+    print(session.link)
+```
+
+Optional-value FFL flags use natural Python values. For example, `receipt=True` emits
+`--receipt` without a value, while `receipt="me@example.com"` emits the flag with the
+address.
+
+### Stream a source without a temporary file
+
+`share_stream()` passes a binary file-like object directly to FFL stdin. It is useful
+for database dumps, generated artifacts, and other data that should not first be
+materialized as a separate temporary file:
+
+```python
+with open("backup.tar", "rb") as source:
+    with ffl.share_stream(source, name="backup.tar") as session:
+        print(session.link)
+```
+
+## Download
+
+```python
+result = ffl.download("https://example.fastfilelink/...", output_path="download.bin")
+print(result.output_path)
+print(result.transfer_mode)
+```
+
+`download()` waits for the foreground FFL process to finish and returns a
+`DownloadResult`. For cancellation, progress, or caller-controlled timeouts, use
+`start_download()` and manage its `DownloadSession` explicitly.
+
+### Stream a download
+
+`download_stream()` exposes FFL stdout as binary chunks without buffering the whole
+file in memory:
+
+```python
+with ffl.download_stream("https://example.fastfilelink/...") as transfer:
+    with open("output.bin", "wb") as target:
+        for chunk in transfer.iter_bytes():
+            target.write(chunk)
+
+    result = transfer.wait()
+```
+
+Consume `iter_bytes()` through EOF before calling `wait()`. Calling `wait()` with
+unconsumed streamed stdout raises `RuntimeError`; this avoids silently discarding
+binary data or deadlocking when the child process fills its stdout pipe.
+
+## Authentication secrets
+
+For shares protected with HTTP Basic Auth, FFL supports `FFL_AUTH_PASSWORD`. Set it in
+the application environment and pass only `auth_user` to keep the password out of the
+FFL command line:
+
+```bash
+export FFL_AUTH_PASSWORD='use-your-secret-manager'
+```
+
+```powershell
+$env:FFL_AUTH_PASSWORD = 'use-your-secret-manager'
+```
+
+```python
+with ffl.share("release.zip", auth_user="deploy") as session:
+    print(session.link)
+```
+
+Do not also pass `auth_password=` when using this pattern: FFL gives the explicit CLI
+option precedence over `FFL_AUTH_PASSWORD`. The environment variable applies to the
+sharing side; pass download credentials explicitly when downloading a protected link.
+
+## Key generation
+
+```python
+result = ffl.keygen("alice")
+print(result.public_key_path)
+print(result.private_key_path)
+```
+
+`keygen()` has a 60-second process timeout and verifies that the key paths reported by
+FFL exist.
+
+## Version and raw access
+
+```python
+print(ffl.version())
+result = ffl.raw(["download", "--help"])
+```
+
+`raw()` is the escape hatch for new FFL options or commands that the semantic API has
+not adopted yet.
+
+## WSL2
+
+If an operation fails with `TLSError([0x6300])`, WSL may be routing the bundled
+`.com` APE through Windows interop. Run the following in WSL, then restart the WSL
+session:
+
+```bash
+sudo sh -c 'echo -1 > /proc/sys/fs/binfmt_misc/WSLInterop'
+```
+
+## Updating the FFL binding
+
+Install APEBind from its source project. When adopting a new `ffl.com`, first inspect the
+CLI into a raw discovery file:
+
+```bash
+./scripts/inspect.sh /path/to/ffl.com
+```
+
+This writes `binding/ffl.discovered.apebind.yaml` and automatically applies the hidden
+command seeds in `binding/ffl.commands.yaml`. Review the discovered-schema diff, then
+manually merge CLI changes into the canonical semantic contract
+`binding/ffl.apebind.yaml`. Automatic inspection never overwrites the semantic contract.
+
+After reviewing the semantic schema, regenerate the low-level binding:
+
+```bash
+./scripts/regenerate.sh /path/to/ffl.com
+# Windows: .\scripts\regenerate.ps1 D:\ffl.com
+```
+
+The script invokes APEBind into an isolated temporary project and replaces only these
+machine-owned files:
+
+- `src/ffl/_generated.py`
+- `src/ffl/_runtime.py`
+- `src/ffl/bin/ffl.com`
+- `src/ffl/py.typed`
+
+It deliberately does not overwrite `client.py`, `models.py`, parsing logic, tests, or the
+semantic schema.

ffl_python-0.1.4/README.md

@@ -0,0 +1,190 @@
+# ffl-python
+
+Python binding for FastFileLink. The package bundles the portable `ffl.com` APE and
+runs it behind a Python API; callers do not need to locate or install a separate FFL
+binary.
+
+The low-level command grammar is generated by APEBind from `binding/ffl.apebind.yaml`.
+The public API in `src/ffl/client.py` is intentionally handwritten so FFL-specific
+library semantics stay explicit and reviewable.
+
+## Development
+
+```bash
+python -m venv .venv
+.venv/Scripts/python -m pip install -e ".[dev]"   # Windows
+# or: .venv/bin/python -m pip install -e ".[dev]"
+
+.\scripts\test.ps1                 # Windows
+# or: ./scripts/test.sh              # Linux/macOS
+
+.\scripts\build.ps1                # Windows
+# or: ./scripts/build.sh             # Linux/macOS
+```
+
+The test directly imports `ffl`, shares a binary file, and downloads it through the
+bundled `ffl.com` APE. It requires working network access to FastFileLink. A wheel is a
+build artifact, not the source of truth.
+
+The integration suite covers ordinary, E2EE, relay, pickup-code, and public-key
+transfers; text, bytes, folders, multiple files, QR images, hooks, explicit ports, and
+session shutdown, and Basic Auth download.
+
+## Share
+
+```python
+import ffl
+
+with ffl.share("release.zip", max_downloads=1, timeout_seconds=1800) as session:
+    print(session.link)
+```
+
+`share()` always requests a foreground FFL process and disables clipboard side effects,
+which gives library callers a deterministic `ShareSession` they can stop or keep alive.
+FFL's runtime-owned `--json` output is used internally to wait until `session.link` is
+ready.
+
+Multiple files are accepted directly:
+
+```python
+session = ffl.share(["one.txt", "two.txt"], name="files.zip")
+```
+
+Text and bytes helpers own their temporary file until the share session is closed:
+
+```python
+with ffl.share_text("hello", name="hello.txt") as session:
+    print(session.link)
+```
+
+Optional-value FFL flags use natural Python values. For example, `receipt=True` emits
+`--receipt` without a value, while `receipt="me@example.com"` emits the flag with the
+address.
+
+### Stream a source without a temporary file
+
+`share_stream()` passes a binary file-like object directly to FFL stdin. It is useful
+for database dumps, generated artifacts, and other data that should not first be
+materialized as a separate temporary file:
+
+```python
+with open("backup.tar", "rb") as source:
+    with ffl.share_stream(source, name="backup.tar") as session:
+        print(session.link)
+```
+
+## Download
+
+```python
+result = ffl.download("https://example.fastfilelink/...", output_path="download.bin")
+print(result.output_path)
+print(result.transfer_mode)
+```
+
+`download()` waits for the foreground FFL process to finish and returns a
+`DownloadResult`. For cancellation, progress, or caller-controlled timeouts, use
+`start_download()` and manage its `DownloadSession` explicitly.
+
+### Stream a download
+
+`download_stream()` exposes FFL stdout as binary chunks without buffering the whole
+file in memory:
+
+```python
+with ffl.download_stream("https://example.fastfilelink/...") as transfer:
+    with open("output.bin", "wb") as target:
+        for chunk in transfer.iter_bytes():
+            target.write(chunk)
+
+    result = transfer.wait()
+```
+
+Consume `iter_bytes()` through EOF before calling `wait()`. Calling `wait()` with
+unconsumed streamed stdout raises `RuntimeError`; this avoids silently discarding
+binary data or deadlocking when the child process fills its stdout pipe.
+
+## Authentication secrets
+
+For shares protected with HTTP Basic Auth, FFL supports `FFL_AUTH_PASSWORD`. Set it in
+the application environment and pass only `auth_user` to keep the password out of the
+FFL command line:
+
+```bash
+export FFL_AUTH_PASSWORD='use-your-secret-manager'
+```
+
+```powershell
+$env:FFL_AUTH_PASSWORD = 'use-your-secret-manager'
+```
+
+```python
+with ffl.share("release.zip", auth_user="deploy") as session:
+    print(session.link)
+```
+
+Do not also pass `auth_password=` when using this pattern: FFL gives the explicit CLI
+option precedence over `FFL_AUTH_PASSWORD`. The environment variable applies to the
+sharing side; pass download credentials explicitly when downloading a protected link.
+
+## Key generation
+
+```python
+result = ffl.keygen("alice")
+print(result.public_key_path)
+print(result.private_key_path)
+```
+
+`keygen()` has a 60-second process timeout and verifies that the key paths reported by
+FFL exist.
+
+## Version and raw access
+
+```python
+print(ffl.version())
+result = ffl.raw(["download", "--help"])
+```
+
+`raw()` is the escape hatch for new FFL options or commands that the semantic API has
+not adopted yet.
+
+## WSL2
+
+If an operation fails with `TLSError([0x6300])`, WSL may be routing the bundled
+`.com` APE through Windows interop. Run the following in WSL, then restart the WSL
+session:
+
+```bash
+sudo sh -c 'echo -1 > /proc/sys/fs/binfmt_misc/WSLInterop'
+```
+
+## Updating the FFL binding
+
+Install APEBind from its source project. When adopting a new `ffl.com`, first inspect the
+CLI into a raw discovery file:
+
+```bash
+./scripts/inspect.sh /path/to/ffl.com
+```
+
+This writes `binding/ffl.discovered.apebind.yaml` and automatically applies the hidden
+command seeds in `binding/ffl.commands.yaml`. Review the discovered-schema diff, then
+manually merge CLI changes into the canonical semantic contract
+`binding/ffl.apebind.yaml`. Automatic inspection never overwrites the semantic contract.
+
+After reviewing the semantic schema, regenerate the low-level binding:
+
+```bash
+./scripts/regenerate.sh /path/to/ffl.com
+# Windows: .\scripts\regenerate.ps1 D:\ffl.com
+```
+
+The script invokes APEBind into an isolated temporary project and replaces only these
+machine-owned files:
+
+- `src/ffl/_generated.py`
+- `src/ffl/_runtime.py`
+- `src/ffl/bin/ffl.com`
+- `src/ffl/py.typed`
+
+It deliberately does not overwrite `client.py`, `models.py`, parsing logic, tests, or the
+semantic schema.

ffl_python-0.1.4/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ffl-python"
+version = "0.1.4"
+description = "Python binding for FastFileLink, backed by the portable ffl.com APE"
+readme = "README.md"
+requires-python = ">=3.11"
+authors = [{name = "ffl-python contributors"}]
+license = "Apache-2.0"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/nuwainfo/ffl-python"
+
+[project.optional-dependencies]
+dev = ["pytest>=8", "build>=1.2", "PyYAML>=6.0", "setuptools>=68", "wheel>=0.42"]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+ffl = ["bin/*", "py.typed"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q"

ffl_python-0.1.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+