bump: version 0.19.2 → 0.20.0

really it's for 'wuttaweb' - just the basics, hopefully can add
generator logic to wutta project soon instead

but for now the wuttjamaican quick start docs will reference the
online Rattail Demo site for generating new project code

CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to rattail will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## v0.20.0 (2024-11-24)
+
+### Feat
+
+- add project generator for 'wutta'
+
+### Fix
+
+- tweak generated output for new python/rattail projects
+- avoid error in product autocomplete for duplicated key
+- add problem report for duplicated product keys
+
 ## v0.19.2 (2024-11-18)
 
 ### Fix

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "rattail"
-version = "0.19.2"
+version = "0.20.0"
 description = "Retail Software Framework"
 readme = "README.md"
 authors = [{name = "Lance Edgar", email = "lance@edbob.org"}]
@@ -49,7 +49,7 @@ dependencies = [
         "texttable",
         "typer",
         "typing-extensions",
-        "WuttJamaican>=0.13.0",
+        "WuttJamaican>=0.14.0",
         "xlrd",
 ]
 
@@ -115,6 +115,7 @@ rattail_integration = "rattail.projects.rattail_integration:RattailIntegrationPr
 rattail_shopfoo = "rattail.projects.rattail_shopfoo:RattailShopfooProjectGenerator"
 tailbone_integration = "rattail.projects.tailbone_integration:TailboneIntegrationProjectGenerator"
 tailbone_shopfoo = "rattail.projects.tailbone_shopfoo:TailboneShopfooProjectGenerator"
+wutta = "rattail.projects.wutta:WuttaProjectGenerator"
 
 
 [project.entry-points."rattail.reports"]

rattail/projects/python/pyproject.toml.mako

@@ -11,7 +11,7 @@ version = "0.1.0"
 description = "${description}"
 readme = "README.md"
 authors = [{name = "Your Name", email = "you@example.com"}]
-keywords = ["tech support", "tech support cooperative"]
+keywords = ["${name}"]
 classifiers = [
         % for classifier in sorted(classifiers):
         "${classifier}",

rattail/projects/rattail_adjacent/package/config.py.mako

@@ -17,7 +17,7 @@ class ${studly_prefix}Config(ConfigExtension):
 
         # app info
         config.setdefault('rattail.app_title', "${name.replace('"', '\\"')}")
-        config.setdefault('rattail.app_package', "${pkg_name}")
+        config.setdefault('rattail.app_dist', "${pypi_name}")
 
         % if has_model:
         # primary data model

rattail/projects/wutta.py

@@ -0,0 +1,197 @@
+# -*- coding: utf-8; -*-
+################################################################################
+#
+#  Rattail -- Retail Software Framework
+#  Copyright © 2010-2024 Lance Edgar
+#
+#  This file is part of Rattail.
+#
+#  Rattail is free software: you can redistribute it and/or modify it under the
+#  terms of the GNU General Public License as published by the Free Software
+#  Foundation, either version 3 of the License, or (at your option) any later
+#  version.
+#
+#  Rattail is distributed in the hope that it will be useful, but WITHOUT ANY
+#  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+#  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+#  details.
+#
+#  You should have received a copy of the GNU General Public License along with
+#  Rattail.  If not, see <http://www.gnu.org/licenses/>.
+#
+################################################################################
+"""
+Project Generators
+"""
+
+import os
+import re
+
+from rattail.projects.base import PythonProjectGenerator
+
+
+class WuttaProjectGenerator(PythonProjectGenerator):
+    """
+    Wutta project generator.
+    """
+    key = 'wutta'
+
+    def normalize_context(self, context):
+        """ """
+        context = super().normalize_context(context)
+
+        # TODO
+        context['has_cli'] = True
+
+        # classifiers
+        context['classifiers'].update(set([
+            'Environment :: Web Environment',
+            'Framework :: Pyramid',
+        ]))
+
+        # dependencies
+        context['requires'].setdefault('psycopg2', True)
+        context['requires'].setdefault('Wutta-Continuum', True)
+        context['requires'].setdefault('WuttaWeb', True)
+
+        # entry point for config extension
+        context['entry_points'].setdefault('wutta.config.extensions', []).extend([
+            f"{context['pkg_name']} = {context['pkg_name']}.config:{context['studly_prefix']}Config"])
+
+        # entry point for paste (web app)
+        context['entry_points'].setdefault('paste.app_factory', []).extend([
+            f"main = {context['pkg_name']}.web.app:main"])
+
+        return context
+
+    def generate_project(self, output, context, **kwargs):
+        """ """
+        from alembic.config import Config as AlembicConfig
+        from alembic.command import revision as alembic_revision
+
+        super().generate_project(output, context, **kwargs)
+
+        ##############################
+        # root package dir
+        ##############################
+
+        package = os.path.join(output, context['pkg_name'])
+
+        self.generate('package/config.py.mako',
+                      os.path.join(package, 'config.py'),
+                      context)
+
+        self.generate('package/commands.py.mako',
+                      os.path.join(package, 'commands.py'),
+                      context)
+
+        ##############################
+        # db package dir
+        ##############################
+
+        db = os.path.join(package, 'db')
+        os.makedirs(db)
+
+        self.generate('package/db/__init__.py',
+                      os.path.join(db, '__init__.py'))
+
+        ####################
+        # model
+        ####################
+
+        model = os.path.join(db, 'model')
+        os.makedirs(model)
+
+        self.generate('package/db/model/__init__.py.mako',
+                      os.path.join(model, '__init__.py'),
+                      context)
+
+        ####################
+        # alembic
+        ####################
+
+        alembic = os.path.join(db, 'alembic')
+        os.makedirs(alembic)
+
+        versions = os.path.join(alembic, 'versions')
+        os.makedirs(versions)
+
+        # make alembic config, aware of new project versions folder
+        alembic_config = AlembicConfig()
+        alembic_config.set_main_option('script_location',
+                                       'wuttjamaican.db:alembic')
+        alembic_config.set_main_option('version_locations',
+                                       ' '.join([
+                                           versions,
+                                           'wuttjamaican.db:alembic/versions',
+                                       ]))
+
+        # generate first revision script for new project
+        script = alembic_revision(alembic_config,
+                                  version_path=versions,
+                                  head='wutta@head',
+                                  splice=True,
+                                  branch_label=context['pkg_name'],
+                                  message=f"add {context['pkg_name']} branch")
+
+        # declare `down_revision = None` ..no way to tell alembic
+        # to do that apparently, so we must rewrite file
+        with open(script.path, 'rt') as f:
+            old_contents = f.read()
+        new_contents = []
+        for line in old_contents.split('\n'):
+            if line.startswith('down_revision ='):
+                line = re.sub(r"'\w+'", 'None', line)
+            new_contents.append(line)
+        with open(script.path, 'wt') as f:
+            f.write('\n'.join(new_contents))
+
+        ##############################
+        # web package dir
+        ##############################
+
+        web = os.path.join(package, 'web')
+        os.makedirs(web)
+
+        self.generate('package/web/__init__.py',
+                      os.path.join(web, '__init__.py'))
+
+        self.generate('package/web/app.py.mako',
+                      os.path.join(web, 'app.py'),
+                      context)
+
+        self.generate('package/web/menus.py.mako',
+                      os.path.join(web, 'menus.py'),
+                      context)
+
+        self.generate('package/web/subscribers.py.mako',
+                      os.path.join(web, 'subscribers.py'),
+                      context)
+
+        static = os.path.join(web, 'static')
+        os.makedirs(static)
+
+        self.generate('package/web/static/__init__.py.mako',
+                      os.path.join(static, '__init__.py'),
+                      context)
+
+        libcache = os.path.join(static, 'libcache')
+        os.makedirs(libcache)
+
+        self.generate('package/web/static/libcache/README.mako',
+                      os.path.join(libcache, 'README'),
+                      context)
+
+        web_templates = os.path.join(web, 'templates')
+        os.makedirs(web_templates)
+
+        self.generate('package/web/templates/base_meta.mako_tmpl',
+                      os.path.join(web_templates, 'base_meta.mako'),
+                      context)
+
+        views = os.path.join(web, 'views')
+        os.makedirs(views)
+
+        self.generate('package/web/views/__init__.py.mako',
+                      os.path.join(views, '__init__.py'),
+                      context)

rattail/projects/wutta/package/commands.py.mako

@@ -0,0 +1,31 @@
+## -*- coding: utf-8; mode: python; -*-
+# -*- coding: utf-8; -*-
+"""
+${name} commands
+"""
+
+import typer
+
+from wuttjamaican.cli import make_typer
+
+
+${pkg_name}_typer = make_typer(
+    name='${pkg_name}',
+    help="${name} -- ${description}"
+)
+
+
+@${pkg_name}_typer.command()
+def install(
+        ctx: typer.Context,
+):
+    """
+    Install the ${name} app
+    """
+    config = ctx.parent.wutta_config
+    app = config.get_app()
+    install = app.get_install_handler(pkg_name='${pkg_name}',
+                                      app_title="${name}",
+                                      pypi_name='${pypi_name}',
+                                      egg_name='${egg_name}')
+    install.run()

rattail/projects/wutta/package/config.py.mako

@@ -0,0 +1,30 @@
+## -*- coding: utf-8; mode: python; -*-
+# -*- coding: utf-8; -*-
+"""
+${name} config extensions
+"""
+
+from wuttjamaican.conf import WuttaConfigExtension
+
+
+class ${studly_prefix}Config(WuttaConfigExtension):
+    """
+    Config extension for ${name}
+    """
+    key = '${pkg_name}'
+
+    def configure(self, config):
+
+        # app info
+        config.setdefault(f'{config.appname}.app_title', "${name.replace('"', '\\"')}")
+        config.setdefault(f'{config.appname}.app_dist', "${pypi_name}")
+
+        # app model
+        config.setdefault(f'{config.appname}.model_spec', '${pkg_name}.db.model')
+
+        # web app menu
+        config.setdefault(f'{config.appname}.web.menus.handler_spec',
+                          '${pkg_name}.web.menus:${studly_prefix}MenuHandler')
+
+        # web app libcache
+        #config.setdefault('tailbone.static_libcache.module', '${pkg_name}.web.static')

rattail/projects/wutta/package/db/model/__init__.py.mako

@@ -0,0 +1,10 @@
+## -*- coding: utf-8; mode: python; -*-
+# -*- coding: utf-8; -*-
+"""
+${name} data models
+"""
+
+# bring in all of wutta
+from wuttjamaican.db.model import *
+
+# TODO: import other/custom models here...

rattail/projects/wutta/package/web/app.py.mako

@@ -0,0 +1,29 @@
+## -*- coding: utf-8; mode: python; -*-
+# -*- coding: utf-8; -*-
+"""
+${name} web app
+"""
+
+from wuttaweb import app as base
+
+
+def main(global_config, **settings):
+    """
+    This function returns a Pyramid WSGI application.
+    """
+    # prefer ${name} templates over wuttaweb
+    settings.setdefault('mako.directories', [
+        '${pkg_name}.web:templates',
+        'wuttaweb:templates',
+    ])
+
+    # make config objects
+    wutta_config = base.make_wutta_config(settings)
+    pyramid_config = base.make_pyramid_config(settings)
+
+    # bring in the rest of ${name}
+    pyramid_config.include('${pkg_name}.web.static')
+    pyramid_config.include('${pkg_name}.web.subscribers')
+    pyramid_config.include('${pkg_name}.web.views')
+
+    return pyramid_config.make_wsgi_app()

rattail/projects/wutta/package/web/menus.py.mako

@@ -0,0 +1,27 @@
+## -*- coding: utf-8; mode: python; -*-
+# -*- coding: utf-8; -*-
+"""
+${name} Menu
+"""
+
+from wuttaweb import menus as base
+
+
+class ${studly_prefix}MenuHandler(base.MenuHandler):
+    """
+    ${name} menu handler
+    """
+
+    def make_menus(self, request, **kwargs):
+
+        # TODO: override this if you need custom menus...
+
+        # menus = [
+        #     self.make_products_menu(request),
+        #     self.make_admin_menu(request),
+        # ]
+
+        # ...but for now this uses default menus
+        menus = super().make_menus(request, **kwargs)
+
+        return menus

rattail/projects/wutta/package/web/static/__init__.py.mako

@@ -0,0 +1,23 @@
+## -*- coding: utf-8; mode: python; -*-
+# -*- coding: utf-8; -*-
+"""
+Static assets
+"""
+
+# from fanstatic import Library, Resource
+
+
+# # libcache
+# libcache = Library('${pkg_name}_libcache', 'libcache')
+# bb_vue_js = Resource(libcache, 'vue.esm-browser-3.3.11.prod.js')
+# bb_oruga_js = Resource(libcache, 'oruga-0.8.10.js')
+# bb_oruga_bulma_js = Resource(libcache, 'oruga-bulma-0.3.0.js')
+# bb_oruga_bulma_css = Resource(libcache, 'oruga-bulma-0.3.0.css')
+# bb_fontawesome_svg_core_js = Resource(libcache, 'fontawesome-svg-core-6.5.2.js')
+# bb_free_solid_svg_icons_js = Resource(libcache, 'free-solid-svg-icons-6.5.2.js')
+# bb_vue_fontawesome_js = Resource(libcache, 'vue-fontawesome-3.0.6.index.es.js')
+
+
+def includeme(config):
+    config.include('wuttaweb.static')
+    config.add_static_view('${pkg_name}', '${pkg_name}.web:static', cache_max_age=3600)

rattail/projects/wutta/package/web/static/libcache/README.mako

@@ -0,0 +1,2 @@
+Place files in this folder, which correspond to the Resource()
+definitions found in `${pkg_name}/web/static/__init__.py`

rattail/projects/wutta/package/web/subscribers.py.mako

@@ -0,0 +1,17 @@
+## -*- coding: utf-8; mode: python; -*-
+# -*- coding: utf-8; -*-
+"""
+Pyramid event subscribers
+"""
+
+import ${pkg_name}
+
+
+def add_${pkg_name}_to_context(event):
+    renderer_globals = event
+    renderer_globals['${pkg_name}'] = ${pkg_name}
+
+
+def includeme(config):
+    config.include('wuttaweb.subscribers')
+    config.add_subscriber(add_${pkg_name}_to_context, 'pyramid.events.BeforeRender')

rattail/projects/wutta/package/web/templates/base_meta.mako_tmpl

@@ -0,0 +1,17 @@
+## -*- coding: utf-8; mode: html; -*-
+<%%inherit file="wuttaweb:templates/base_meta.mako" />
+
+## TODO: you can override parent template as needed below, or you
+## can simply delete this file if no customizations are needed
+
+<%%def name="favicon()">
+  ${parent.favicon()}
+</%%def>
+
+<%%def name="header_logo()">
+  ${parent.header_logo()}
+</%%def>
+
+<%%def name="footer()">
+  ${parent.footer()}
+</%%def>

rattail/projects/wutta/package/web/views/__init__.py.mako

@@ -0,0 +1,14 @@
+## -*- coding: utf-8; mode: python; -*-
+# -*- coding: utf-8; -*-
+"""
+${name} Views
+"""
+
+
+def includeme(config):
+
+    # core views for wuttaweb
+    config.include('wuttaweb.views.essential')
+
+    # TODO: include your own views here
+    #config.include('${pkg_name}.web.views.widgets')