hosted-flasks 0.0.1__tar.gz

hosted-flasks-0.0.1/.github/README.md

@@ -0,0 +1,18 @@
+# Hosted Flasks
+
+> serve flask apps side by side
+
+[![Latest Version on PyPI](https://img.shields.io/pypi/v/hosted-flasks.svg)](https://pypi.python.org/pypi/hosted-flasks/)
+[![Supported Implementations](https://img.shields.io/pypi/pyversions/hosted-flasks.svg)](https://pypi.python.org/pypi/hosted-flasks/)
+![Build Status](https://github.com/christophevg/hosted-flasks/actions/workflows/test.yaml/badge.svg)
+[![Documentation Status](https://readthedocs.org/projects/hosted-flasks/badge/?version=latest)](https://hosted-flasks.readthedocs.io/en/latest/?badge=latest)
+[![Coverage Status](https://coveralls.io/repos/github/christophevg/hosted-flasks/badge.svg?branch=master)](https://coveralls.io/github/christophevg/hosted-flasks?branch=master)
+[![Built with PyPi Template](https://img.shields.io/badge/PyPi_Template-v0.5.0-blue.svg)](https://github.com/christophevg/pypi-template)
+
+
+
+## Documentation
+
+Visit [Read the Docs](https://hosted-flasks.readthedocs.org) for the full documentation, including overviews and several examples.
+
+

hosted-flasks-0.0.1/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2024 Christophe VG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

hosted-flasks-0.0.1/MANIFEST.in

@@ -0,0 +1,3 @@
+include .github/README.md
+global-exclude __pycache__
+global-exclude *.py[co]

hosted-flasks-0.0.1/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.1
+Name: hosted-flasks
+Version: 0.0.1
+Summary: serve flask apps side by side
+Home-page: https://github.com/christophevg/hosted-flasks
+Author: Christophe VG
+License: MIT
+Description: # Hosted Flasks
+        
+        > serve flask apps side by side
+        
+        [![Latest Version on PyPI](https://img.shields.io/pypi/v/hosted-flasks.svg)](https://pypi.python.org/pypi/hosted-flasks/)
+        [![Supported Implementations](https://img.shields.io/pypi/pyversions/hosted-flasks.svg)](https://pypi.python.org/pypi/hosted-flasks/)
+        ![Build Status](https://github.com/christophevg/hosted-flasks/actions/workflows/test.yaml/badge.svg)
+        [![Documentation Status](https://readthedocs.org/projects/hosted-flasks/badge/?version=latest)](https://hosted-flasks.readthedocs.io/en/latest/?badge=latest)
+        [![Coverage Status](https://coveralls.io/repos/github/christophevg/hosted-flasks/badge.svg?branch=master)](https://coveralls.io/github/christophevg/hosted-flasks?branch=master)
+        [![Built with PyPi Template](https://img.shields.io/badge/PyPi_Template-v0.5.0-blue.svg)](https://github.com/christophevg/pypi-template)
+        
+        
+        
+        ## Documentation
+        
+        Visit [Read the Docs](https://hosted-flasks.readthedocs.org) for the full documentation, including overviews and several examples.
+        
+        
+        
+Keywords: multiple flask apps
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Description-Content-Type: text/markdown

hosted-flasks-0.0.1/docs/conf.py

@@ -0,0 +1,36 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = u'Hosted Flasks'
+copyright = u'2024-2024, Christophe VG'
+author = u'Christophe VG'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ["myst_parser", "autodoc2"]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+autodoc2_render_plugin = "myst"
+
+autodoc2_packages = [
+  {
+    "path": "../hosted_flasks",
+    "exclude_dirs" : [ "templates" ],
+    "auto_mode": False
+  }
+]
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+
+html_static_path = ["_static"]

hosted-flasks-0.0.1/hosted_flasks/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

hosted-flasks-0.0.1/hosted_flasks/__main__.py

@@ -0,0 +1,6 @@
+import json
+
+from hosted_flasks import scanner
+from hosted_flasks import server
+
+print(json.dumps(scanner.find_apps(server.APPS_FOLDER), indent=2, default=str))

hosted-flasks-0.0.1/hosted_flasks/frontpage.py

@@ -0,0 +1,23 @@
+import logging
+
+import os
+
+from pathlib import Path
+
+from flask import Flask, render_template
+
+logger = logging.getLogger(__name__)
+
+TEMPLATE_FOLDER = os.environ.get(
+  "HOSTED_FLASKS_TEMPLATE_FOLDER",
+  Path(__file__).resolve().parent / "templates"
+)
+logger.info(f"using template_folder: {TEMPLATE_FOLDER}")
+
+app = Flask("hosted-flasks", template_folder=TEMPLATE_FOLDER)
+
+apps = {}
+
+@app.route("/")
+def show_frontpage():
+  return render_template("frontpage.html", apps=apps)

hosted-flasks-0.0.1/hosted_flasks/log_setup.py

@@ -0,0 +1,15 @@
+import logging
+
+import os
+
+# setup logging to stdout
+
+logger = logging.getLogger(__name__)
+
+LOG_LEVEL = os.environ.get("LOG_LEVEL") or "INFO"
+FORMAT    = "[%(name)s] [%(levelname)s] %(message)s"
+DATEFMT   = "%Y-%m-%d %H:%M:%S %z"
+
+logging.basicConfig(level=LOG_LEVEL, format=FORMAT, datefmt=DATEFMT)
+formatter = logging.Formatter(FORMAT, DATEFMT)
+logging.getLogger().handlers[0].setFormatter(formatter)

hosted-flasks-0.0.1/hosted_flasks/scanner.py

@@ -0,0 +1,31 @@
+import logging
+
+from pathlib import Path
+import importlib.util
+import sys
+
+logger = logging.getLogger(__name__)
+
+def find_apps(apps_folder):
+  """
+  given a folder, finds all Flask apps and returns them as a dict with keys
+  path-name and value the flask app
+  """
+  logger.info(f"loading apps from: {apps_folder}")
+  apps = {}
+  for folder in Path(apps_folder).iterdir():
+    if folder.is_dir():
+      logger.info(f"loading {folder.name}")
+      try:
+        spec = importlib.util.spec_from_file_location(folder.name, folder / "__init__.py")
+        mod = importlib.util.module_from_spec(spec)
+        sys.modules[folder.name] = mod
+        spec.loader.exec_module(mod)
+        app = getattr(mod, "app")
+        app_name = str(folder.name)
+        apps[f"/{app_name}"] = app
+      except FileNotFoundError:
+        pass
+      except AttributeError:
+        logger.warning(f"'{folder.name}' doesn't provide 'app'")
+  return apps

hosted-flasks-0.0.1/hosted_flasks/server.py

@@ -0,0 +1,21 @@
+import logging
+import os
+
+from werkzeug.middleware.dispatcher import DispatcherMiddleware
+
+import hosted_flasks.log_setup #noqa
+
+from hosted_flasks import scanner
+from hosted_flasks import frontpage
+
+logger = logging.getLogger(__name__)
+
+# load modules/apps dynamically
+
+APPS_FOLDER = os.environ.get("HOSTED_FLASKS_APPS_FOLDER", "apps")
+apps = scanner.find_apps(APPS_FOLDER)
+frontpage.apps = apps
+
+# combine the apps with the frontpage
+
+app = DispatcherMiddleware(frontpage.app, apps)

hosted-flasks-0.0.1/hosted_flasks.egg-info/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.1
+Name: hosted-flasks
+Version: 0.0.1
+Summary: serve flask apps side by side
+Home-page: https://github.com/christophevg/hosted-flasks
+Author: Christophe VG
+License: MIT
+Description: # Hosted Flasks
+        
+        > serve flask apps side by side
+        
+        [![Latest Version on PyPI](https://img.shields.io/pypi/v/hosted-flasks.svg)](https://pypi.python.org/pypi/hosted-flasks/)
+        [![Supported Implementations](https://img.shields.io/pypi/pyversions/hosted-flasks.svg)](https://pypi.python.org/pypi/hosted-flasks/)
+        ![Build Status](https://github.com/christophevg/hosted-flasks/actions/workflows/test.yaml/badge.svg)
+        [![Documentation Status](https://readthedocs.org/projects/hosted-flasks/badge/?version=latest)](https://hosted-flasks.readthedocs.io/en/latest/?badge=latest)
+        [![Coverage Status](https://coveralls.io/repos/github/christophevg/hosted-flasks/badge.svg?branch=master)](https://coveralls.io/github/christophevg/hosted-flasks?branch=master)
+        [![Built with PyPi Template](https://img.shields.io/badge/PyPi_Template-v0.5.0-blue.svg)](https://github.com/christophevg/pypi-template)
+        
+        
+        
+        ## Documentation
+        
+        Visit [Read the Docs](https://hosted-flasks.readthedocs.org) for the full documentation, including overviews and several examples.
+        
+        
+        
+Keywords: multiple flask apps
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Description-Content-Type: text/markdown

hosted-flasks-0.0.1/hosted_flasks.egg-info/SOURCES.txt

@@ -0,0 +1,19 @@
+LICENSE.txt
+MANIFEST.in
+setup.py
+.github/README.md
+docs/__init__.py
+docs/conf.py
+hosted_flasks/__init__.py
+hosted_flasks/__main__.py
+hosted_flasks/frontpage.py
+hosted_flasks/log_setup.py
+hosted_flasks/scanner.py
+hosted_flasks/server.py
+hosted_flasks.egg-info/PKG-INFO
+hosted_flasks.egg-info/SOURCES.txt
+hosted_flasks.egg-info/dependency_links.txt
+hosted_flasks.egg-info/requires.txt
+hosted_flasks.egg-info/top_level.txt
+tests/__init__.py
+tests/test_example.py

hosted-flasks-0.0.1/hosted_flasks.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

hosted-flasks-0.0.1/hosted_flasks.egg-info/requires.txt

@@ -0,0 +1 @@
+Flask

hosted-flasks-0.0.1/hosted_flasks.egg-info/top_level.txt

@@ -0,0 +1,3 @@
+docs
+hosted_flasks
+tests

hosted-flasks-0.0.1/setup.cfg

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

hosted-flasks-0.0.1/setup.py

@@ -0,0 +1,64 @@
+import os
+import re
+import setuptools
+
+NAME             = "hosted-flasks"
+AUTHOR           = "Christophe VG"
+AUTHOR_EMAIL     = "contact@christophe.vg"
+DESCRIPTION      = "serve flask apps side by side"
+LICENSE          = "MIT"
+KEYWORDS         = "multiple flask apps"
+URL              = "https://github.com/christophevg/" + NAME
+README           = ".github/README.md"
+CLASSIFIERS      = [
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Environment :: Web Environment",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  
+]
+INSTALL_REQUIRES = [
+  "Flask",
+  
+]
+ENTRY_POINTS = {
+  
+}
+SCRIPTS = [
+  
+]
+
+HERE = os.path.dirname(__file__)
+
+def read(file):
+  with open(os.path.join(HERE, file), "r") as fh:
+    return fh.read()
+
+VERSION = re.search(
+  r'__version__ = [\'"]([^\'"]*)[\'"]',
+  read(NAME.replace("-", "_") + "/__init__.py")
+).group(1)
+
+LONG_DESCRIPTION = read(README)
+
+if __name__ == "__main__":
+  setuptools.setup(
+    name=NAME,
+    version=VERSION,
+    packages=setuptools.find_packages(),
+    author=AUTHOR,
+    description=DESCRIPTION,
+    long_description=LONG_DESCRIPTION,
+    long_description_content_type="text/markdown",
+    license=LICENSE,
+    keywords=KEYWORDS,
+    url=URL,
+    classifiers=CLASSIFIERS,
+    install_requires=INSTALL_REQUIRES,
+    entry_points=ENTRY_POINTS,
+    scripts=SCRIPTS,
+    include_package_data=True    
+  )

hosted-flasks-0.0.1/tests/test_example.py

@@ -0,0 +1,37 @@
+from hosted_flasks.scanner import find_apps
+
+def test_app_detection(tmp_path):
+  assert find_apps(tmp_path) == {}
+  # create 2 miminal apps
+  for app_name in [ "app_1", "app_2" ]:
+    folder = tmp_path / app_name
+    folder.mkdir()
+    init = folder / "__init__.py"
+    init.write_text("""
+from flask import Flask
+
+app = Flask(__name__)
+
+@app.route("/")
+def hello_world():
+  return "Hello World"  
+""")
+  apps = find_apps(tmp_path)
+  assert len(apps) == 2
+  assert list(apps.keys()) == [ "/app_1", "/app_2" ]
+
+  # add dummy folder / coverage of FileNotFound
+  dummy = tmp_path / "dummy"
+  dummy.mkdir()
+
+  apps = find_apps(tmp_path)
+  assert len(apps) == 2
+  assert list(apps.keys()) == [ "/app_1", "/app_2" ]
+  
+  # add empty __init__.py / coverage of AttributeError
+  init = dummy / "__init__.py"
+  init.write_text("# nothing here")
+
+  apps = find_apps(tmp_path)
+  assert len(apps) == 2
+  assert list(apps.keys()) == [ "/app_1", "/app_2" ]