deploy at 2024-08-30 23:55:04.515882

.gitignore

@@ -0,0 +1,147 @@
+_proc/
+_quarto.yml
+sidebar.yml
+Gemfile.lock
+token
+_docs/
+conda/
+.last_checked
+.gitconfig
+*.bak
+*.log
+*~
+~*
+_tmp*
+tmp*
+tags
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+.vscode
+*.swp
+
+# osx generated files
+.DS_Store
+.DS_Store?
+.Trashes
+ehthumbs.db
+Thumbs.db
+.idea
+
+# pytest
+.pytest_cache
+
+# tools/trust-doc-nbs
+docs_src/.last_checked
+
+# symlinks to fastai
+docs_src/fastai
+tools/fastai
+
+# link checker
+checklink/cookies.txt
+
+# .gitconfig is now autogenerated
+.gitconfig
+
+_docs

Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.10
+WORKDIR /code
+COPY --link --chown=1000 . .
+RUN mkdir -p /tmp/cache/
+RUN chmod a+rwx -R /tmp/cache/
+ENV HF_HUB_CACHE=HF_HOME
+RUN pip install --no-cache-dir -r requirements.txt
+
+ENV PYTHONUNBUFFERED=1 PORT=7860
+CMD ["python", "main.py"]

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.

README.md

@@ -1,10 +1,29 @@
----
-title: Htmltofasthtml
-emoji: ⚡
-colorFrom: purple
-colorTo: green
-sdk: docker
-pinned: false
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# FastHTML on 🤗 Spaces
+
+Deploy a FastHTML application to [HuggingFace Spaces](https://huggingface.co/spaces) for free with one command!
+
+## Quickstart
+
+1. Create a free account on [HuggingFace](https://huggingface.co)
+2. Go to your account settings and create an access token with write access. Keep this token safe and don't share it.
+3. Set the `HF_TOKEN` environment variable to that token
+4. Install fasthtml-hf: `pip install fasthtml-hf`
+5. HuggingFace needs `fasthtml-hf` to run your space, so add it to your requirements.txt file.
+6. At the top of your `main.py` add `from fasthtml_hf import setup_hf_backup`, and just before you run uvicorn add `setup_hf_backup(app)`
+7. Run `fh_hf_deploy <space_name>`, replacing `<space_name>` with the name you want to give your space.
+
+By default this will upload a public space. You can make it private with `--private true`.
+
+## Configuration
+
+The space will upload a backup of your database to a [HuggingFace Dataset](https://huggingface.co/datasets). By default it will be private and its name will be `<your-huggingface-id>/space-backup`. You can change this behavior in the `config.ini` file. In not provided, a default file will be created with the contents (note that the `[DEFAULT]` line is required at the top):
+
+```
+[DEFAULT]
+dataset_id = space-backup
+db_dir = data
+private_backup = True
+interval = 15 # number of minutes between periodic backups
+```
+
+If you so choose, you can disable the automatic backups and use [persistent storage](https://huggingface.co/docs/hub/en/spaces-storage#persistent-storage-specs) instead for $5/month (USD). 

fasthtml_hf/__init__.py

@@ -0,0 +1,2 @@
+from .deploy import *
+from .backup import *

fasthtml_hf/backup.py

@@ -0,0 +1,49 @@
+import os, shutil
+os.environ['HF_HUB_DISABLE_PROGRESS_BARS'] = '1'
+import time
+from fastcore.utils import *
+from datetime import datetime
+from huggingface_hub import snapshot_download, upload_folder, create_repo, repo_exists, whoami
+
+__all__ = ['download', 'upload', 'setup_hf_backup']
+def _token(): return os.getenv("HF_TOKEN")
+
+def get_cfg():
+    return Config('.', 'config.ini',
+                  types=dict(dataset_id=str, db_dir=str, private_backup=bool, interval=int),
+                  create=dict(dataset_id='space-backup', db_dir='data', private_backup=True, interval=15))
+
+def get_dataset_id(cfg):
+    did = cfg.dataset_id
+    if "/" in did or _token() is None: return did
+    return f"{whoami(_token())['name']}/{did}"
+
+def download():
+    cfg = get_cfg()
+    did = get_dataset_id(cfg)
+    upload_on_schedule()
+    if os.getenv("SPACE_ID") and repo_exists(did, repo_type="dataset", token=_token()):
+        cache_path = snapshot_download(repo_id=did, repo_type='dataset', token=_token())
+        shutil.copytree(cache_path, cfg.db_dir, dirs_exist_ok=True)
+
+def upload():
+    cfg = get_cfg()
+    if not os.getenv("SPACE_ID"): return
+    did = get_dataset_id(cfg)
+    create_repo(did, token=_token(), private=True, repo_type='dataset', exist_ok=True)
+    upload_folder(folder_path=cfg.db_dir, token=_token(), repo_id=did,
+                  repo_type='dataset', commit_message=f"backup {datetime.now()}")
+
+
+@threaded
+def upload_on_schedule():
+    cfg = get_cfg()
+    while True:
+        time.sleep(cfg.interval*60)
+        upload()
+
+
+def setup_hf_backup(app):
+    app.on_event("startup")(download)
+    app.on_event("shutdown")(upload)
+

fasthtml_hf/deploy.py

@@ -0,0 +1,74 @@
+import datetime
+from huggingface_hub import create_repo, upload_folder, add_space_secret, whoami
+from fastcore.utils import *
+from fastcore.script import *
+
+def _mk_docker(python_ver):
+    fn = Path('Dockerfile')
+    if fn.exists(): return
+    packages = Path('packages.txt')
+    pkg_line = ''
+    reqs = Path('requirements.txt')
+    if not reqs.exists(): reqs.write_text('python-fasthtml\nfasthtml-hf\n')
+    req_line = f'RUN pip install --no-cache-dir -r requirements.txt'
+    if packages.exists():
+        pkglist = ' '.join(packages.readlines())
+        pkg_line = f'RUN apt-get update -y && apt-get install -y {pkglist}'
+
+    cts = f"""FROM python:{python_ver}
+WORKDIR /code
+COPY --link --chown=1000 . .
+RUN mkdir -p /tmp/cache/
+RUN chmod a+rwx -R /tmp/cache/
+ENV HF_HUB_CACHE=HF_HOME
+{req_line}
+{pkg_line}
+ENV PYTHONUNBUFFERED=1 PORT=7860
+CMD ["python", "main.py"]
+"""
+    fn.write_text(cts)
+
+
+def _mk_README(space_id, termination_grace_period):
+    fn = Path('README.md')
+    if fn.exists(): return
+    cts = f"""
+---
+title: {space_id}
+emoji: 🚀
+colorFrom: purple
+colorTo: red
+sdk: docker
+app_file: app.py
+pinned: false
+termination_grace_period: {termination_grace_period}
+---
+"""
+    fn.write_text(cts)
+
+@call_parse
+def deploy(
+    space_id:str, # ID of the space to upload to
+    token:str=None, # Hugging Face token for authentication
+    python_ver:str='3.10', # Version of python to use
+    upload:bool_arg=True, # Set to `false` to skip uploading files
+    private:bool_arg=False,
+    termination_grace_period:str="2m"): # Make the repository private
+    "Upload current directory to Hugging Face Spaces"
+    if not token: token=os.getenv('HF_TOKEN')
+    if not token: return print('No token available')
+    if "/" not in space_id: space_id = f"{whoami(token)['name']}/{space_id}"
+    _mk_docker(python_ver)
+    _mk_README(space_id, termination_grace_period)
+    private = bool(private) # `private` can be 0,1 or False. As `create_repo` expects private to be True/False we cast it.
+    url = create_repo(space_id, token=token, repo_type='space',
+                      space_sdk="docker", private=private, exist_ok=True)
+    if not upload: return print('Repo created; upload skipped')
+    upload_folder(folder_path=Path("."),
+                repo_id=space_id, repo_type='space',
+                ignore_patterns=['__pycache__/*', '.sesskey', 'deploy_hf.py', 'data/*'],
+                commit_message=f"deploy at {datetime.datetime.now()}",
+                token=token)
+    add_space_secret(space_id, token=token, key="HF_TOKEN", value=token)
+    print(f"Deployed space at {url}")
+

main.py

@@ -0,0 +1,18 @@
+from fasthtml.common import *
+
+app,rt = fast_app(hdrs=[HighlightJS()])
+
+@rt("/convert")
+def post(html:str, attr1st:bool): return Pre(Code(html2ft(html, attr1st=str2bool(attr1st)))) if html else ''
+
+@rt("/")
+def get():
+    return Titled(
+        "Convert HTML to FT",
+        Form(hx_post='/convert', target_id="ft", hx_trigger="change from:#attr1st, keyup delay:500ms from:#html")(
+            Select(style="width: auto", id="attr1st")(
+                Option("Children 1st", value="0", selected=True), Option("Attrs 1st", value="1")),
+            Textarea(placeholder='Paste HTML here', id="html", rows=10)),
+        Div(id="ft"))
+
+serve()

pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "fasthtml-hf"
+version = "0.1.4"
+description = "Huggingface deployment for FastHTML"
+readme = "README.md"
+license = { file = "LICENSE" }
+authors = [
+    { name = "Jeremy Howard", email = "[email protected]" },
+    { name = "Freddy Boulton", email = "[email protected]" }
+]
+requires-python = ">=3.7, <4"
+dependencies = [ "fastcore", "huggingface-hub" ]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License"
+]
+
+[project.urls]
+"Homepage" = "https://github.com/AnswerDotAI/fasthtml-hf"
+
+[project.entry-points.console_scripts]
+fh_hf_deploy = "fasthtml_hf:deploy"
+

requirements.txt

@@ -0,0 +1,2 @@
+python-fasthtml>=0.0.8
+huggingface-hub>=0.20.0