okfile 1.2.0__tar.gz

okfile-1.2.0/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.

okfile-1.2.0/PKG-INFO

@@ -0,0 +1,252 @@
+Metadata-Version: 2.4
+Name: okfile
+Version: 1.2.0
+Summary: Python CLI for uploading files and publishing static sites to OkFile
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://www.okfile.com
+Project-URL: Repository, https://github.com/okfilecom/okfile
+Project-URL: Issues, https://github.com/okfilecom/okfile/issues
+Keywords: okfile,upload,publish,cli,cloudflare,r2
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31.0
+Dynamic: license-file
+
+# OkFile
+
+Agent-first file upload and publish service built on Cloudflare Pages Functions, R2, and D1.
+
+- Website: `https://www.okfile.com`
+- Repository: `https://github.com/okfilecom/okfile`
+- License: `Apache-2.0`
+
+## What It Does
+
+OkFile is designed for Agents, scripts, and lightweight manual upload use cases.
+
+It supports:
+
+- anonymous uploads
+- authenticated uploads with user API keys
+- direct file URLs for download or embedding
+- preview/playback URLs for image, video, and PDF
+- multipart upload for large files up to `500MB`
+- phase-1 site directory upload with nested subdirectories and per-site subdomain publish URLs
+- automatic shared top-level directory stripping for folder-based site uploads
+- directory listing fallback when a published site does not contain root `index.html`
+- retrying only missing parts after incomplete multipart uploads
+- email magic-link login and account management
+- localized home, upload, and account pages
+
+## Main User Flows
+
+### 1. Anonymous Publish
+
+1. `POST /api/upload/prepare`
+2. `PUT uploadUrl` or each `parts[].uploadUrl`
+3. `POST /api/upload/complete`
+4. return `url` and optionally `playUrl`
+
+### 2. API Key Publish
+
+1. request a magic link and log in
+2. create an API key in `/account`
+3. call `POST /api/upload/prepare` with `apiKey`
+4. upload file data to signed URLs
+5. call `POST /api/upload/complete`
+
+### 3. Manual Upload
+
+Users can also use:
+
+- `/zh/upload/`
+- `/en/upload/`
+
+This path is kept as a fallback entry, while API integration remains the recommended flow.
+
+### 4. Site Directory Publish
+
+1. select a whole folder in `/zh/upload/` or `/en/upload/`
+2. the uploader preserves nested relative paths
+3. if every file sits under one shared top-level folder, that folder is stripped and treated as the site root
+4. if the site contains root `index.html`, `/` renders that page
+5. if root `index.html` does not exist, `/` renders a directory listing with file name, size, and upload time
+6. image and video entries open inline, while other files use download links
+
+## Architecture
+
+### Runtime
+
+- Cloudflare Pages Functions for routing and API handling
+- Cloudflare Worker route for `*.ok26.org/*` site subdomains
+- Cloudflare R2 for file storage
+- Cloudflare D1 for auth and API key metadata
+- Resend for email magic links
+
+### Frontend
+
+- static `index.html` for homepage
+- static `upload.html` for manual upload
+- server-side localization and SEO injection in `worker-app.js`
+
+### Backend Responsibilities
+
+- issue presigned R2 upload URLs
+- complete multipart uploads
+- activate public file routes
+- resolve published site subdomains from request `Host`
+- manage sessions, magic links, and API keys
+- enforce anonymous and per-key quota limits
+
+## Core Routes
+
+### Pages
+
+- `/zh/` and `/en/`: localized home pages
+- `/zh/upload/` and `/en/upload/`: manual upload pages
+- `/account`: redirects to localized account page
+- `/zh/account/` and `/en/account/`: localized account pages
+- `/admin`: admin console
+
+### Upload APIs
+
+- `POST /api/upload/prepare`
+- `POST /api/upload/complete`
+- `GET /api/upload/status/{id}`
+
+### Auth APIs
+
+- `POST /api/auth/request-link`
+- `GET /auth/verify?token=...`
+- `GET /api/account/me`
+- `POST /api/account/api-keys`
+
+### File URLs
+
+- `/i/{id}`: direct file URL
+- `/i/{id}?play=1`: preview/playback page
+- `/d/{id}`: controlled download route
+
+### Site URLs
+
+- `https://{subdomain}.ok26.org/`: site root or directory listing
+- `https://{subdomain}.ok26.org/path/to/file`: published site asset or document
+- `https://{subdomain}.ok26.org/path/to/file?download=1`: force download for a site file
+
+## Repository Layout
+
+```text
+.
+|- worker-app.js                      # main Pages Function entry
+|- index.html                         # homepage
+|- upload.html                        # manual upload page
+|- schema.sql                         # D1 schema
+|- wrangler.toml                      # Cloudflare config
+|- SKILL.md                           # root skill document
+|- .trae/skills/okfile/SKILL.md       # Trae skill definition
+|- okfile-upload-pitfalls.md          # upload pitfalls and debugging notes
+```
+
+## Local Development
+
+Install dependencies:
+
+```bash
+npm install
+```
+
+Run local development:
+
+```bash
+npx wrangler pages dev .
+```
+
+Deploy to Cloudflare Pages:
+
+```bash
+npx wrangler pages deploy . --project-name okfile --branch main
+```
+
+## Configuration
+
+Store secrets in Cloudflare, not in the repository.
+
+### Secrets
+
+- `R2_ACCESS_KEY_ID`
+- `R2_SECRET_ACCESS_KEY`
+- `RESEND_API_KEY`
+
+### Plain-Text Vars
+
+- `R2_ACCOUNT_ID`
+- `RESEND_FROM_EMAIL`
+- `ADMIN_EMAILS`
+
+## Database
+
+The D1 schema is defined in `schema.sql` and includes:
+
+- `users`
+- `magic_links`
+- `sessions`
+- `api_keys`
+- `api_key_usage_windows`
+
+## Upload Notes
+
+See these repo docs for integration details:
+
+- `SKILL.md`
+- `SITE_UPLOAD_DESIGN.md`
+- `.trae/skills/okfile/SKILL.md`
+- `okfile-upload-pitfalls.md`
+
+The pitfalls doc includes practical notes such as:
+
+- Cloudflare requiring a normal `User-Agent` for some requests
+- explicit `Content-Length` on R2 PUT
+- multipart retry strategy
+- large-file client recommendations on Windows
+
+For site publishing:
+
+- use root `index.html` when you want the subdomain root to render a page
+- if you upload a single wrapper folder such as `my-site/...`, OkFile strips `my-site/` automatically
+- if no root `index.html` exists, users land on a browsable directory listing instead of downloading an arbitrary file
+
+## Articles
+
+Published and outward-facing articles are archived in `docs/`:
+
+- docs/README.md
+- docs/devto-agent-delivery-publish-file-or-site-test-guide.md
+- docs/aliyun-workbuddy-agent-file-site-publish-test-guide.md
+
+## Contributing
+
+Please read `CONTRIBUTING.md` before opening pull requests.
+
+## Security
+
+Please read `SECURITY.md` for reporting instructions and secret-handling rules.
+
+## Changelog
+
+See `CHANGELOG.md` for release notes tracked in-repo.
+
+## License
+
+Apache-2.0

okfile-1.2.0/README.md

@@ -0,0 +1,226 @@
+# OkFile
+
+Agent-first file upload and publish service built on Cloudflare Pages Functions, R2, and D1.
+
+- Website: `https://www.okfile.com`
+- Repository: `https://github.com/okfilecom/okfile`
+- License: `Apache-2.0`
+
+## What It Does
+
+OkFile is designed for Agents, scripts, and lightweight manual upload use cases.
+
+It supports:
+
+- anonymous uploads
+- authenticated uploads with user API keys
+- direct file URLs for download or embedding
+- preview/playback URLs for image, video, and PDF
+- multipart upload for large files up to `500MB`
+- phase-1 site directory upload with nested subdirectories and per-site subdomain publish URLs
+- automatic shared top-level directory stripping for folder-based site uploads
+- directory listing fallback when a published site does not contain root `index.html`
+- retrying only missing parts after incomplete multipart uploads
+- email magic-link login and account management
+- localized home, upload, and account pages
+
+## Main User Flows
+
+### 1. Anonymous Publish
+
+1. `POST /api/upload/prepare`
+2. `PUT uploadUrl` or each `parts[].uploadUrl`
+3. `POST /api/upload/complete`
+4. return `url` and optionally `playUrl`
+
+### 2. API Key Publish
+
+1. request a magic link and log in
+2. create an API key in `/account`
+3. call `POST /api/upload/prepare` with `apiKey`
+4. upload file data to signed URLs
+5. call `POST /api/upload/complete`
+
+### 3. Manual Upload
+
+Users can also use:
+
+- `/zh/upload/`
+- `/en/upload/`
+
+This path is kept as a fallback entry, while API integration remains the recommended flow.
+
+### 4. Site Directory Publish
+
+1. select a whole folder in `/zh/upload/` or `/en/upload/`
+2. the uploader preserves nested relative paths
+3. if every file sits under one shared top-level folder, that folder is stripped and treated as the site root
+4. if the site contains root `index.html`, `/` renders that page
+5. if root `index.html` does not exist, `/` renders a directory listing with file name, size, and upload time
+6. image and video entries open inline, while other files use download links
+
+## Architecture
+
+### Runtime
+
+- Cloudflare Pages Functions for routing and API handling
+- Cloudflare Worker route for `*.ok26.org/*` site subdomains
+- Cloudflare R2 for file storage
+- Cloudflare D1 for auth and API key metadata
+- Resend for email magic links
+
+### Frontend
+
+- static `index.html` for homepage
+- static `upload.html` for manual upload
+- server-side localization and SEO injection in `worker-app.js`
+
+### Backend Responsibilities
+
+- issue presigned R2 upload URLs
+- complete multipart uploads
+- activate public file routes
+- resolve published site subdomains from request `Host`
+- manage sessions, magic links, and API keys
+- enforce anonymous and per-key quota limits
+
+## Core Routes
+
+### Pages
+
+- `/zh/` and `/en/`: localized home pages
+- `/zh/upload/` and `/en/upload/`: manual upload pages
+- `/account`: redirects to localized account page
+- `/zh/account/` and `/en/account/`: localized account pages
+- `/admin`: admin console
+
+### Upload APIs
+
+- `POST /api/upload/prepare`
+- `POST /api/upload/complete`
+- `GET /api/upload/status/{id}`
+
+### Auth APIs
+
+- `POST /api/auth/request-link`
+- `GET /auth/verify?token=...`
+- `GET /api/account/me`
+- `POST /api/account/api-keys`
+
+### File URLs
+
+- `/i/{id}`: direct file URL
+- `/i/{id}?play=1`: preview/playback page
+- `/d/{id}`: controlled download route
+
+### Site URLs
+
+- `https://{subdomain}.ok26.org/`: site root or directory listing
+- `https://{subdomain}.ok26.org/path/to/file`: published site asset or document
+- `https://{subdomain}.ok26.org/path/to/file?download=1`: force download for a site file
+
+## Repository Layout
+
+```text
+.
+|- worker-app.js                      # main Pages Function entry
+|- index.html                         # homepage
+|- upload.html                        # manual upload page
+|- schema.sql                         # D1 schema
+|- wrangler.toml                      # Cloudflare config
+|- SKILL.md                           # root skill document
+|- .trae/skills/okfile/SKILL.md       # Trae skill definition
+|- okfile-upload-pitfalls.md          # upload pitfalls and debugging notes
+```
+
+## Local Development
+
+Install dependencies:
+
+```bash
+npm install
+```
+
+Run local development:
+
+```bash
+npx wrangler pages dev .
+```
+
+Deploy to Cloudflare Pages:
+
+```bash
+npx wrangler pages deploy . --project-name okfile --branch main
+```
+
+## Configuration
+
+Store secrets in Cloudflare, not in the repository.
+
+### Secrets
+
+- `R2_ACCESS_KEY_ID`
+- `R2_SECRET_ACCESS_KEY`
+- `RESEND_API_KEY`
+
+### Plain-Text Vars
+
+- `R2_ACCOUNT_ID`
+- `RESEND_FROM_EMAIL`
+- `ADMIN_EMAILS`
+
+## Database
+
+The D1 schema is defined in `schema.sql` and includes:
+
+- `users`
+- `magic_links`
+- `sessions`
+- `api_keys`
+- `api_key_usage_windows`
+
+## Upload Notes
+
+See these repo docs for integration details:
+
+- `SKILL.md`
+- `SITE_UPLOAD_DESIGN.md`
+- `.trae/skills/okfile/SKILL.md`
+- `okfile-upload-pitfalls.md`
+
+The pitfalls doc includes practical notes such as:
+
+- Cloudflare requiring a normal `User-Agent` for some requests
+- explicit `Content-Length` on R2 PUT
+- multipart retry strategy
+- large-file client recommendations on Windows
+
+For site publishing:
+
+- use root `index.html` when you want the subdomain root to render a page
+- if you upload a single wrapper folder such as `my-site/...`, OkFile strips `my-site/` automatically
+- if no root `index.html` exists, users land on a browsable directory listing instead of downloading an arbitrary file
+
+## Articles
+
+Published and outward-facing articles are archived in `docs/`:
+
+- docs/README.md
+- docs/devto-agent-delivery-publish-file-or-site-test-guide.md
+- docs/aliyun-workbuddy-agent-file-site-publish-test-guide.md
+
+## Contributing
+
+Please read `CONTRIBUTING.md` before opening pull requests.
+
+## Security
+
+Please read `SECURITY.md` for reporting instructions and secret-handling rules.
+
+## Changelog
+
+See `CHANGELOG.md` for release notes tracked in-repo.
+
+## License
+
+Apache-2.0