flask-nginx 0.8.0__tar.gz

flask_nginx-0.8.0/.gitignore

@@ -0,0 +1,133 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+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
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+footprint.egg-info
+app/node_modules
+
+.vscode/

flask_nginx-0.8.0/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: flask-nginx
+Version: 0.8.0
+Summary: install flask websites into nginx
+Author-email: arabidopsis <ian.castleden@uwa.edu.au>
+Requires-Python: >=3.10
+Requires-Dist: flask>=2.0
+Provides-Extra: psutil
+Requires-Dist: psutil>=5.4; extra == 'psutil'
+Description-Content-Type: text/markdown
+
+# footprint 👣
+
+I use this to generate config files for my flask apps. Currently systemd and nginx.
+It only depends on Flask (which should alread be in the virtualenv).
+
+```bash
+export FLASK_APP=your_package.wsgi
+footprint config nginx www.example.com > example.conf
+footprint config nginx-install example.conf
+```
+
+```bash
+# install in ~/.config/systemd/user
+export FLASK_APP=your_package.wsgi
+footprint config systemd --user  > example.service
+footprint config systemd-install --user example.service
+```
+
+will install nginx and systemd files that will statically serve you 'static' assets and
+run the Flask app with gunicorn.
+
+Mostly I've found that confectioning these files by hand are highly error prone. These
+commands will at least get the absolute pathnames correct :)
+
+Install with:
+
+```bash
+python -m pip install flask-nginx
+python -m pip install -U git+https://github.com/arabidopsis/footprint.git
+# or
+# git clone https://github.com/arabidopsis/footprint.git
+# cd footprint
+# python -m pip install [--editable] .
+```
+
+or add to your `pyproject.toml` file
+
+```toml
+footprint = { git = "https://github.com/arabidopsis/footprint.git", branch="main" }
+```
+
+Once installed you can upgrade with:
+
+```bash
+footprint update
+# or
+uv pip install -U $(footprint repo)
+```
+
+If `footprint` finds a `pyproject.toml` file in the current directory
+if will try to load `[tool.footprint]` values into its global configuration object.
+
+```bash
+footprint mysql --host=mysql://{user}:{pw}@{src}/{db} dump /var/www/websites/{repo}/instance/sql
+# rsync the entire repo
+footprint rsync {src}:/var/www/websites/{repo} {tgt}
+footprint mysql  --host=mysql://{user}:{pw}@{src}/{db} load /var/www/websites/{repo}/instance/sql/{db}.sql.gz
+```
+
+## `nginx`, `systemd` and all that
+
+Note that these configuration generating functions are
+not infallible. Please examine the generated configure files
+_carefully_! They are mainly useful for getting the directory
+names correct etc. So if you move your repo then you will
+have to regenerate and reinstall the files.
+
+- [Nginx Docs](https://docs.nginx.com/nginx/). [Also](https://nginx.org/en/docs/) and [Proxy](https://nginx.org/en/docs/http/ngx_http_proxy_module.html)
+
+Test an nginx config with e.g.:
+
+```bash
+website=~/Sites/websites/ppr
+export FLASK_APP=ppr.wsgi
+footprint config nginx --app-dir=$website example.org | footprint config nginx-run --app-dir=$website -
+```
+
+This will run nginx at the terminal listening on port 2048 and run the backend
+website.
+
+To install a website:
+
+```bash
+footprint config nginx --app-dir=$website example.org -o website.conf
+footprint config systemd [--user] --app-dir=$website -o website.service
+# nginx requires sudo (default) or su
+footprint config nginx-install website.conf
+# if you can install into ~/.config/systemd/user
+footprint config systemd-install [--user] website.service
+```
+
+You can test _this_ locally by editing `/etc/hosts` and adding a line:
+
+`127.0.0.1 example.org`
+
+to the file.
+
+**REMEMBER**: Unix file permissions mean that you should edit `/etc/nginx/nginx.conf`
+and change `user www-data;` to `user {you};` Or (recursively) change the owner on
+all the repo directories to `www-data`.
+
+If you install as "user" (i.e. `footprint config systemd --user ...`) then
+**to ensure that the user systemd starts at boot time use**: `sudo loginctl enable-linger <user>`
+
+See [here](https://nts.strzibny.name/systemd-user-services/):
+
+> But what’s the real reason for having user services?
+> To answer that, we have to realize when the enabled service starts and stops.
+> If we enable a user service, it starts on user login, and runs as long as there is a
+> session open for that user. Once the last session dies, the service stops.
+
+---
+
+See [digitalocean.com here](https://www.digitalocean.com/community/tutorials/how-to-serve-flask-applications-with-gunicorn-and-nginx-on-ubuntu-20-04) for a tutorial about serving flask from nginx.
+
+Uninstall with `footprint config nginx-uninstall website.conf` and `footprint config systemd-uninstall [--user] website.service`
+
+### `.flaskenv`
+
+If a `.flaskenv` is found in the repo directory then nginx and systemd will
+read paramters from that file. The keywords should be _uppercase_ version of
+the known parameters. Unknown parameters will be ignored.

flask_nginx-0.8.0/README.md

@@ -0,0 +1,122 @@
+# footprint 👣
+
+I use this to generate config files for my flask apps. Currently systemd and nginx.
+It only depends on Flask (which should alread be in the virtualenv).
+
+```bash
+export FLASK_APP=your_package.wsgi
+footprint config nginx www.example.com > example.conf
+footprint config nginx-install example.conf
+```
+
+```bash
+# install in ~/.config/systemd/user
+export FLASK_APP=your_package.wsgi
+footprint config systemd --user  > example.service
+footprint config systemd-install --user example.service
+```
+
+will install nginx and systemd files that will statically serve you 'static' assets and
+run the Flask app with gunicorn.
+
+Mostly I've found that confectioning these files by hand are highly error prone. These
+commands will at least get the absolute pathnames correct :)
+
+Install with:
+
+```bash
+python -m pip install flask-nginx
+python -m pip install -U git+https://github.com/arabidopsis/footprint.git
+# or
+# git clone https://github.com/arabidopsis/footprint.git
+# cd footprint
+# python -m pip install [--editable] .
+```
+
+or add to your `pyproject.toml` file
+
+```toml
+footprint = { git = "https://github.com/arabidopsis/footprint.git", branch="main" }
+```
+
+Once installed you can upgrade with:
+
+```bash
+footprint update
+# or
+uv pip install -U $(footprint repo)
+```
+
+If `footprint` finds a `pyproject.toml` file in the current directory
+if will try to load `[tool.footprint]` values into its global configuration object.
+
+```bash
+footprint mysql --host=mysql://{user}:{pw}@{src}/{db} dump /var/www/websites/{repo}/instance/sql
+# rsync the entire repo
+footprint rsync {src}:/var/www/websites/{repo} {tgt}
+footprint mysql  --host=mysql://{user}:{pw}@{src}/{db} load /var/www/websites/{repo}/instance/sql/{db}.sql.gz
+```
+
+## `nginx`, `systemd` and all that
+
+Note that these configuration generating functions are
+not infallible. Please examine the generated configure files
+_carefully_! They are mainly useful for getting the directory
+names correct etc. So if you move your repo then you will
+have to regenerate and reinstall the files.
+
+- [Nginx Docs](https://docs.nginx.com/nginx/). [Also](https://nginx.org/en/docs/) and [Proxy](https://nginx.org/en/docs/http/ngx_http_proxy_module.html)
+
+Test an nginx config with e.g.:
+
+```bash
+website=~/Sites/websites/ppr
+export FLASK_APP=ppr.wsgi
+footprint config nginx --app-dir=$website example.org | footprint config nginx-run --app-dir=$website -
+```
+
+This will run nginx at the terminal listening on port 2048 and run the backend
+website.
+
+To install a website:
+
+```bash
+footprint config nginx --app-dir=$website example.org -o website.conf
+footprint config systemd [--user] --app-dir=$website -o website.service
+# nginx requires sudo (default) or su
+footprint config nginx-install website.conf
+# if you can install into ~/.config/systemd/user
+footprint config systemd-install [--user] website.service
+```
+
+You can test _this_ locally by editing `/etc/hosts` and adding a line:
+
+`127.0.0.1 example.org`
+
+to the file.
+
+**REMEMBER**: Unix file permissions mean that you should edit `/etc/nginx/nginx.conf`
+and change `user www-data;` to `user {you};` Or (recursively) change the owner on
+all the repo directories to `www-data`.
+
+If you install as "user" (i.e. `footprint config systemd --user ...`) then
+**to ensure that the user systemd starts at boot time use**: `sudo loginctl enable-linger <user>`
+
+See [here](https://nts.strzibny.name/systemd-user-services/):
+
+> But what’s the real reason for having user services?
+> To answer that, we have to realize when the enabled service starts and stops.
+> If we enable a user service, it starts on user login, and runs as long as there is a
+> session open for that user. Once the last session dies, the service stops.
+
+---
+
+See [digitalocean.com here](https://www.digitalocean.com/community/tutorials/how-to-serve-flask-applications-with-gunicorn-and-nginx-on-ubuntu-20-04) for a tutorial about serving flask from nginx.
+
+Uninstall with `footprint config nginx-uninstall website.conf` and `footprint config systemd-uninstall [--user] website.service`
+
+### `.flaskenv`
+
+If a `.flaskenv` is found in the repo directory then nginx and systemd will
+read paramters from that file. The keywords should be _uppercase_ version of
+the known parameters. Unknown parameters will be ignored.

flask_nginx-0.8.0/flask_nginx/__main__.py

@@ -0,0 +1,19 @@
+# pylint: disable=unused-import
+from __future__ import annotations
+
+from . import irds  # noqa:
+from . import mailer  # noqa:
+from . import mysql  # noqa:
+from . import remote  # noqa:
+from . import restartd  # noqa:
+from . import rsync  # noqa:
+from . import watch  # noqa:
+from .cli import cli
+from .systemd import nginx  # noqa:
+from .systemd import supervisor  # noqa:
+from .systemd import systemd  # noqa:
+
+# from . import logo  # noqa:
+
+if __name__ == "__main__":
+    cli.main(prog_name="footprint")

flask_nginx-0.8.0/flask_nginx/cli.py

@@ -0,0 +1,111 @@
+from __future__ import annotations
+
+import subprocess
+
+import click
+
+
+@click.group(
+    # cls=DYMGroup,
+    epilog=click.style("Commands to manage websites\n", fg="magenta"),
+)
+@click.version_option()
+def cli() -> None:
+    pass
+
+
+@cli.command()
+def update() -> None:
+    """Update this package"""
+    import sys
+
+    from .config import REPO
+
+    ret = subprocess.call([sys.executable, "-m", "pip", "install", "-U", REPO])
+    if ret:
+        click.secho(f"can't install {REPO}", fg="red")
+        raise click.Abort()
+
+
+@cli.command()
+def repo() -> None:
+    """show git repository"""
+
+    from .config import REPO
+
+    click.echo(REPO)
+
+
+@cli.command()
+def config_show() -> None:
+    """Show configuration"""
+    from dataclasses import fields
+    from .config import get_config
+
+    Config = get_config()
+
+    n = max(len(f.name) for f in fields(Config))
+
+    for f in fields(Config):
+        k = f.name
+        v = getattr(Config, f.name)
+        click.echo(f"{k:<{n}}: {v}")
+
+
+@cli.command()
+@click.option("-a", "--append", is_flag=True, help="append to file")
+@click.argument("filename")
+def config_dump(filename: str, append: bool) -> None:
+    """Dump configuration"""
+    from .utils import require_mod
+    from .config import dump_to_file
+
+    require_mod("toml")
+
+    if not dump_to_file(filename, append):
+        click.secho("can't dump configuration!", fg="red", err=True)
+        raise click.Abort()
+
+
+# @cli.command()
+# @click.option("-p", "--with-python", is_flag=True)
+# @click.option("-c", "--compile", "use_pip_compile", is_flag=True)
+# @click.argument("project_dir", required=False)
+def poetry_to_reqs(
+    project_dir: str,
+    with_python: bool,
+    use_pip_compile: bool = True,
+) -> None:
+    """Generate a requirements.txt file from pyproject.toml [**may require toml**]"""
+    import os
+    from contextlib import suppress
+    from .utils import toml_load
+
+    pyproject = "pyproject.toml"
+    if project_dir:
+        pyproject = os.path.join(project_dir, pyproject)
+    if not os.path.isfile(pyproject):
+        raise click.BadArgumentUsage("no pyproject.toml file!")
+
+    def fix(req: str) -> str:
+        if req.startswith("^"):
+            return f">={req[1:]}"
+        return req
+
+    reqs = "\n".join(
+        f"{k}{fix(v)}"
+        for k, v in sorted(
+            toml_load(pyproject)["tool"]["poetry"]["dependencies"].items(),
+        )
+        if with_python or k != "python" and isinstance(v, str)
+    )
+    if use_pip_compile:
+        try:
+            with open("requirements.in", "w", encoding="utf-8") as fp:
+                click.echo(reqs, file=fp)
+            subprocess.check_call(["pip-compile"])
+        finally:
+            with suppress(OSError):
+                os.remove("requirements.in")
+    else:
+        click.echo(reqs)

flask_nginx-0.8.0/flask_nginx/config.py

@@ -0,0 +1,90 @@
+from __future__ import annotations
+
+import os
+from dataclasses import asdict
+from dataclasses import dataclass
+from dataclasses import field
+from dataclasses import fields
+from dataclasses import replace
+from typing import IO
+
+from .utils import toml_load
+
+
+REPO = "git+https://github.com/arabidopsis/footprint.git"
+
+
+@dataclass
+class Config:
+    mailhost: str = "uwa-edu-au.mail.protection.outlook.com"
+    # mailhost: str = "antivirus.uwa.edu.au"
+    datastore: str = "//drive.irds.uwa.edu.au/sci-ms-001"
+    # directories that *might* be in the static directory
+    static_dir: str = (
+        r"img|images|js|css|media|docs|tutorials|notebooks|downloads|\.well-known"
+    )
+    # basic files that have urls such as /robots.txt /favicon.ico etc.
+    static_files: str = (
+        r"robots\.txt|crossdomain\.xml|favicon\.ico|browserconfig\.xml|humans\.txt"
+    )
+    # exclude these filenames/directories from static consideration
+    exclude: list[str] = field(default_factory=lambda: ["__pycache__"])
+    # directory to put config files: (Ubuntu, RHEL8)
+    nginx_dirs: list[str] = field(
+        default_factory=lambda: ["/etc/nginx/sites-enabled", "/etc/nginx/conf.d"],
+    )
+    arg_color: str = "yellow"  # use "none" for no color
+
+
+XConfig: Config | None = None
+
+
+def get_config() -> Config:
+    global XConfig
+    if XConfig is None:
+        XConfig = _init_config(Config())
+    return XConfig
+
+
+def _init_config(config: Config, application_dir: str = ".") -> Config:
+    project = os.path.join(application_dir, "pyproject.toml")
+    if os.path.isfile(project):
+        try:
+            d = toml_load(project)
+            if "tool" not in d:
+                return config
+            cfg = d["tool"].get("footprint")
+            if cfg is None:
+                return config
+            data = {}
+            for f in fields(config):
+                if f.name in cfg:
+                    data[f.name] = cfg[f.name]
+
+            if data:
+                config = replace(config, **data)
+
+        except ImportError:
+            pass
+        except Exception:
+            import click
+
+            click.secho(f'can\'t load "{project}"', fg="red", bold=True, err=True)
+    return config
+
+
+def dump_toml(config: Config, out: IO[str]) -> bool:
+    try:
+        import toml  # type: ignore
+
+        d = dict(tool=dict(footprint=asdict(config)))
+        toml.dump(d, out)
+        return True
+    except Exception:
+        return False
+
+
+def dump_to_file(filename: str, append: bool) -> bool:
+    config = get_config()
+    with open(filename, "a" if append else "w", encoding="utf-8") as fp:
+        return dump_toml(config, fp)