Duplicate from Wauplin/pynecone-on-spaces-template

Co-authored-by: Lucain Pouget <Wauplin@users.noreply.huggingface.co>

.dockerignore

@@ -0,0 +1,139 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+.venv*
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.venv*
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+.vscode/
+.idea/
+
+.DS_Store
+
+# Pynecone
+pynecone.db
+.web
+node_modules

.gitattributes

@@ -0,0 +1,34 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1,139 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+.venv*
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.venv*
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+.vscode/
+.idea/
+
+.DS_Store
+
+# Pynecone
+pynecone.db
+.web
+node_modules

Dockerfile

@@ -0,0 +1,66 @@
+# See https://hub.docker.com/r/nikolaik/python-nodejs
+#     https://github.com/nikolaik/docker-python-nodejs
+# Default user is 'pn' with uid 1000, gid 1000
+FROM nikolaik/python-nodejs:python3.10-nodejs18
+
+# Install nginx and give permissions to 'pn'
+# See https://www.rockyourcode.com/run-docker-nginx-as-non-root-user/
+USER root
+
+RUN apt-get -y update && apt-get -y install nginx
+
+RUN mkdir -p /var/cache/nginx \
+             /var/log/nginx \
+             /var/lib/nginx
+RUN touch /var/run/nginx.pid
+
+RUN chown -R pn:pn /var/cache/nginx \
+                       /var/log/nginx \
+                       /var/lib/nginx \
+                       /var/run/nginx.pid
+
+# Install dependencies and build app as non-root
+USER pn
+ENV HOME=/home/pn \
+    PATH=/home/pn/.local/bin:$PATH
+
+RUN mkdir $HOME/app
+
+WORKDIR $HOME/app
+
+# Install bun manually
+RUN curl -fsSL https://bun.sh/install | bash
+
+# Install pynecone (in case it's forgotten in requirements.txt)
+RUN pip install --no-cache-dir --upgrade pynecone
+
+# Install additional dependencies
+# To install using a package manager (pipenv, poetry, pdm,...) please adapt this section
+COPY --chown=pn requirements.txt requirements.txt
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Init project
+RUN pc init
+
+# Init frontend
+# Optional: could be done at runtime. But saves time if already done in container build.
+#           It installs all frontend dependencies
+RUN python -c "from pathlib import Path; from pynecone.utils import setup_frontend; setup_frontend(Path.cwd())"
+
+# Copy existing project
+COPY --chown=pn pcconfig_docker.py pcconfig.py
+COPY --chown=pn default_app default_app
+COPY --chown=pn assets assets
+
+# Re-init frontend (if new deps from project)
+RUN python -c "from pathlib import Path; from pynecone.utils import setup_frontend; setup_frontend(Path.cwd())"
+
+# Copy nginx configuration
+COPY --chown=pn nginx.conf /etc/nginx/sites-available/default
+
+# Copy README and entrypoint script
+COPY --chown=pn README.md README.md
+COPY --chown=pn run.sh .
+
+# Run script ('service nginx start' + 'pc run')
+CMD ["bash", "run.sh"]

README.md

@@ -0,0 +1,122 @@
+---
+title: Pynecone On Spaces Template
+emoji: 🐿️
+colorFrom: yellow
+colorTo: blue
+sdk: docker
+app_port: 4444
+pinned: false
+license: mit
+duplicated_from: Wauplin/pynecone-on-spaces-template
+---
+
+Deploy your own Pynecone app to Huggingface Spaces!
+
+Please be aware that this is still a very recent project, still under active maintenance.
+
+If you encounter any issue, please let us know by creating a discussion in our [Community tab](https://huggingface.co/spaces/Wauplin/pynecone-on-spaces-template/discussions).
+
+### Instructions:
+
+
+#### 1. Install deployment tool
+
+
+Install the deployment script [from source](https://github.com/Wauplin/pynecone-on-spaces):
+
+```
+pip install git+https://github.com/Wauplin/pynecone-on-spaces
+```
+
+#### 2. (optional) Login to Huggingface
+
+
+If you don't already have an account, please [register](https://huggingface.co/join) to HF.
+
+You will next need to [setup a token](https://huggingface.co/settings/tokens) with `WRITE` permissions.
+
+Once you have it, login your machine to your account by running the following command in your terminal:
+
+```bash
+huggingface-cli login
+```
+
+#### 3. Deploy 🚀
+
+
+Simply deploy your pynecone app:
+
+```bash
+huggingface-pynecone deploy
+```
+
+**Output:**
+```txt
+New Space created: https://huggingface.co/spaces/Wauplin/clock
+  README.md file not found locally. Adapting the existing remote one.
+  Setup pcconfig.py
+  Setup Dockerfile
+  Sync requirements.txt
+  Sync assets/ folder
+  Sync app folder
+Your app has been successfully deployed!
+Check it out: https://Wauplin-clock.hf.space
+```
+
+The name of your repository will be derived from the app name defined in your `pcconfig.py` file.
+
+For more flexibility, you can specify some arguments:
+
+```bash
+huggingface-pynecone deploy --pcconfig_path="path/to/pcconfig.py" --private --token="hf_xxx"
+```
+
+#### 4. Sync changes
+
+
+Your project is now hosted in a versioned repository on Huggingface.
+
+You can decide to clone the repository and push your changes as you would do with any project.
+Please make sure to not break anything in `README.md` (metadata), `Dockerfile` and `pcconfig_docker.py`.
+
+Otherwise, you can make changes to your existing project and push your changes using the same command:
+
+```bash
+huggingface-pynecone deploy
+```
+
+**Output:**
+
+```txt
+Repo ID: Wauplin/clock
+Space already exist: https://huggingface.co/spaces/Wauplin/clock
+  Space already configured. Do not update README.md, Dockerfile and pcconfig.py
+  Sync requirements.txt
+  Sync assets/ folder
+  Sync app folder
+Your app has been successfully deployed!
+Check it out: https://Wauplin-clock.hf.space
+```
+
+
+### What tweaks are used to deploy you apps?
+
+
+Some tweaks are necessary to make your Pynecone deployed on HF Spaces.
+Everything is taken care of by the `huggingface-pynecone` CLI tool.
+
+List of small tweaks:
+- Running in a Docker Space means only 1 open port:
+  - We use nginx proxy to expose both frontend and backend on same port 4444
+    - Port 3000 (frontend) is redirected to localhost:4444/
+    - Port 8000 (backend) is redirected to localhost:4444/pynecone-backend
+  - Port 4444 is set in several files:
+    - `README.md`: set `app_port` parameter
+    - `nginx.conf`: define which port to listen
+    - `pcconfig.py`: monkey-patch pynecone to make it think the backend is running on port 8000 even though a different `api_url` is set
+- `pc.Config` configuration:
+  - set env as `PROD`
+  - set `api_url` to the Space url + pynecone-backend path. Example: `"https://wauplin-pynecone-counter.hf.space/pynecone-backend"`
+  - set `port` to 3000 (frontend port)
+  - set db_url to `"sqlite:///pynecone.db"` but DB is not persisted across when the Space is reloaded (i.e.: not really a database yet)
+- Use a `run.sh` script to start nginx before running pynecone server

default_app/default_app.py

@@ -0,0 +1,58 @@
+from pathlib import Path
+
+import pynecone as pc
+
+
+class State(pc.State):
+    count: int = 0
+
+    def increment(self):
+        self.count += 1
+
+    def decrement(self):
+        self.count -= 1
+
+
+def index():
+    return pc.center(
+        pc.vstack(
+            pc.box(
+                height="20px",
+            ),
+            pc.box(
+                pc.heading("Pynecone x Spaces 🚀"),
+            ),
+            pc.hstack(
+                pc.button(
+                    "Decrement",
+                    color_scheme="red",
+                    border_radius="1em",
+                    on_click=State.decrement,
+                ),
+                pc.heading(State.count, font_size="2em"),
+                pc.button(
+                    "Increment",
+                    color_scheme="green",
+                    border_radius="1em",
+                    on_click=State.increment,
+                ),
+            ),
+            pc.box(
+                height="50px",
+            ),
+            pc.box(
+                # Hacky way to append README content to the page
+                pc.markdown(
+                    (Path(__file__).parent.parent / "README.md")
+                    .read_text()
+                    .split("---")[-1]
+                    .strip()
+                )
+            ),
+        )
+    )
+
+
+app = pc.App(state=State)
+app.add_page(index)
+app.compile()

nginx.conf

@@ -0,0 +1,29 @@
+server {
+    listen 4444 default_server;
+    listen [::]:4444 default_server;
+
+    server_name _;
+
+    location / {
+        # Serve static frontend from port 3000
+        proxy_pass http://localhost:3000;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection 'upgrade';
+        proxy_set_header Host $host;
+        proxy_cache_bypass $http_upgrade;
+    }
+
+    location /pynecone-backend/event {
+        # Serve backend from port 8000
+        proxy_pass http://localhost:8000/event;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection 'upgrade';
+        proxy_set_header Host "localhost:8000";
+        proxy_pass_request_headers on;
+
+        # Disable cache on websockets
+        expires -1;
+    }
+}

pcconfig.py

@@ -0,0 +1,7 @@
+import pynecone as pc
+
+config = pc.Config(
+    app_name="default_app",
+    db_url="sqlite:///pynecone.db",
+    env=pc.Env.DEV,
+)

pcconfig_docker.py

@@ -0,0 +1,23 @@
+import pynecone as pc
+
+config = pc.Config(
+    app_name="default_app",
+    db_url="sqlite:///pynecone.db",
+    api_url="https://wauplin-pynecone-on-spaces-template.hf.space/pynecone-backend",
+    env=pc.Env.PROD,
+)
+
+### PATCHING 'get_api_port'
+from pynecone import utils
+
+initial_get_api_port = utils.get_api_port
+
+
+def patched_get_api_port() -> int:
+    print(f"Using patched get_api_port (return 8000)")
+    return 8000
+
+
+utils.get_api_port = patched_get_api_port
+print(f"Patched 'get_api_port' to always return 8000.")
+###

requirements.txt

@@ -0,0 +1 @@
+pynecone

run.sh

@@ -0,0 +1,3 @@
+service nginx start
+
+pc run --loglevel=info