docs: update project links, kallithea -> forgejo

per upstream changes

CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to rattail-tutorial will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project (probably doesn't) adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## v0.3.1 (2024-07-01)
+
+### Fix
+
+- remove legacy command definitions
+
+## v0.3.0 (2024-07-01)
+
+### Feat
+
+- migrate all commands to use `typer` framework
+
 ## v0.2.0 (2024-07-01)
 
 ### Feat

README.md

@@ -1,13 +1,9 @@
-.. -*- mode: rst -*-
 
-rattail-tutorial
-================
+# rattail-tutorial
 
 This project is intended for use as a "tutorial" for Rattail app development.
 
 It contains documentation for the tutorial itself, but also contains
 code for the tutorial app, which users may run locally for testing.
 
-See the `Rattail website`_ for more info.
-
-.. _`Rattail website`: https://rattailproject.org/
+See the [Rattail website](https://rattailproject.org/) for more info.

docs/conf.py

@@ -17,12 +17,14 @@
 
 # -- Project information -----------------------------------------------------
 
+from importlib.metadata import version as get_version
+
 project = 'rattail-tutorial'
-copyright = '2019, Lance Edgar'
+copyright = '2019-2024, Lance Edgar'
 author = 'Lance Edgar'
 
 # The full version, including alpha/beta/rc tags
-release = '0.1'
+release = get_version('rattail-tutorial')
 
 
 # -- General configuration ---------------------------------------------------
@@ -51,7 +53,7 @@ todo_include_todos = True
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'furo'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/create-project.rst

@@ -125,7 +125,7 @@ rattail-tutorial app instead, you should do this::
 
    mkdir -p ~/src
    cd ~/src
-   git clone https://rattailproject.org/git/rattail-tutorial.git
+   git clone https://forgejo.wuttaproject.org/rattail/rattail-tutorial.git
    pip install -e rattail-tutorial
 
 Creating the Project

pyproject.toml

@@ -6,9 +6,9 @@ build-backend = "hatchling.build"
 
 [project]
 name = "rattail-tutorial"
-version = "0.2.0"
+version = "0.3.1"
 description = "Rattail Development Tutorial"
-readme = "README.rst"
+readme = "README.md"
 authors = [{name = "Lance Edgar", email = "lance@edbob.org"}]
 license = {text = "GNU GPL v3+"}
 classifiers = [
@@ -24,16 +24,18 @@ classifiers = [
         "Topic :: Office/Business",
 ]
 dependencies = [
+        "furo",
         "invoke",
         "psycopg2",
-        "rattail[auth,db,bouncer]",
+        "rattail[db,bouncer]",
+        "Sphinx",
         "Tailbone",
         "tox",
 ]
 
 
 [project.scripts]
-rattail_tutorial = "rattail_tutorial.commands:main"
+rattail_tutorial = "rattail_tutorial.commands:rattail_tutorial_typer"
 
 
 [project.entry-points."paste.app_factory"]
@@ -41,17 +43,17 @@ main = "rattail_tutorial.web.app:main"
 
 
 [project.entry-points."rattail.config.extensions"]
-rattail_tutorial = "rattail_tutorial.config:Rattail_tutorialConfig"
+rattail_tutorial = "rattail_tutorial.config:RattailTutorialConfig"
 
 
-[project.entry-points."rattail_tutorial.subcommands"]
-hello = "rattail_tutorial.commands:HelloWorld"
+[project.entry-points."rattail.emails"]
+rattail_tutorial = "rattail_tutorial.emails"
 
 
 [project.urls]
 Homepage = "https://rattailproject.org"
-repository = "https://kallithea.rattailproject.org/rattail-project/rattail-tutorial"
-Changelog = "https://kallithea.rattailproject.org/rattail-project/rattail-tutorial/files/master/CHANGELOG.md"
+repository = "https://forgejo.wuttaproject.org/rattail/rattail-tutorial"
+Changelog = "https://forgejo.wuttaproject.org/rattail/rattail-tutorial/src/branch/master/CHANGELOG.md"
 
 
 [tool.commitizen]

rattail_tutorial/commands.py

@@ -2,7 +2,7 @@
 ################################################################################
 #
 #  Rattail -- Retail Software Framework
-#  Copyright © 2010-2019 Lance Edgar
+#  Copyright © 2010-2024 Lance Edgar
 #
 #  This file is part of Rattail.
 #
@@ -26,36 +26,22 @@ Rattail Tutorial commands
 
 import sys
 
-from rattail import commands
+import typer
 
-from rattail_tutorial import __version__
+from rattail.commands.typer import make_typer
 
 
-def main(*args):
-    """
-    Main entry point for Rattail Tutorial command system
-    """
-    args = list(args or sys.argv[1:])
-    cmd = Command()
-    cmd.run(*args)
+rattail_tutorial_typer = make_typer(
+    name='rattail_tutorial',
+    help="Rattail Tutorial (custom Rattail system)"
+)
 
 
-class Command(commands.Command):
-    """
-    Main command for Rattail Tutorial
-    """
-    name = 'rattail_tutorial'
-    version = __version__
-    description = "Rattail Tutorial (custom Rattail system)"
-    long_description = ''
-
-
-class HelloWorld(commands.Subcommand):
+@rattail_tutorial_typer.command()
+def hello(
+        ctx: typer.Context,
+):
     """
     The requisite 'hello world' example
     """
-    name = 'hello'
-    description = __doc__.strip()
-
-    def run(self, args):
-        self.stdout.write("hello world!\n")
+    sys.stdout.write("hello world!\n")

rattail_tutorial/config.py

@@ -2,7 +2,7 @@
 ################################################################################
 #
 #  Rattail -- Retail Software Framework
-#  Copyright © 2010-2019 Lance Edgar
+#  Copyright © 2010-2024 Lance Edgar
 #
 #  This file is part of Rattail.
 #
@@ -24,10 +24,10 @@
 Custom config
 """
 
-from rattail.config import ConfigExtension
+from wuttjamaican.conf import WuttaConfigExtension
 
 
-class Rattail_tutorialConfig(ConfigExtension):
+class RattailTutorialConfig(WuttaConfigExtension):
     """
     Rattail config extension for Rattail Tutorial
     """
@@ -36,5 +36,4 @@ class Rattail_tutorialConfig(ConfigExtension):
     def configure(self, config):
 
         # set some default config values
-        config.setdefault('rattail.mail', 'emails', 'rattail_tutorial.emails')
-        config.setdefault('tailbone', 'menus', 'rattail_tutorial.web.menus')
+        config.setdefault('tailbone.menus.handler', 'rattail_tutorial.web.menus:TutorialMenuHandler')

rattail_tutorial/emails.py

@@ -2,7 +2,7 @@
 ################################################################################
 #
 #  Rattail -- Retail Software Framework
-#  Copyright © 2010-2019 Lance Edgar
+#  Copyright © 2010-2024 Lance Edgar
 #
 #  This file is part of Rattail.
 #
@@ -26,9 +26,6 @@ Custom email profiles
 
 from rattail.mail import Email
 
-# bring in some common ones from rattail
-from rattail.emails import datasync_error_watcher_get_changes, filemon_action_error
-
 
 class rattail_import_sample_updates(Email):
     """

rattail_tutorial/web/menus.py

@@ -2,7 +2,7 @@
 ################################################################################
 #
 #  Rattail -- Retail Software Framework
-#  Copyright © 2010-2019 Lance Edgar
+#  Copyright © 2010-2024 Lance Edgar
 #
 #  This file is part of Rattail.
 #
@@ -24,166 +24,139 @@
 Web Menus
 """
 
+from tailbone import menus as base
 
-def simple_menus(request):
-    url = request.route_url
 
-    menus = [
-        {
+class TutorialMenuHandler(base.MenuHandler):
+    """
+    Demo menu handler
+    """
+
+    def make_menus(self, request, **kwargs):
+
+        products_menu = self.make_products_menu(request)
+
+        vendors_menu = self.make_vendors_menu(request)
+
+        company_menu = self.make_company_menu(request)
+
+        batches_menu = self.make_batches_menu(request)
+
+        admin_menu = self.make_admin_menu(request,
+                                          include_stores=False,
+                                          include_tenders=False)
+
+        menus = [
+            products_menu,
+            vendors_menu,
+            company_menu,
+            batches_menu,
+            admin_menu,
+        ]
+
+        return menus
+
+    def make_products_menu(self, request, **kwargs):
+        return {
             'title': "Products",
             'type': 'menu',
             'items': [
                 {
                     'title': "Products",
-                    'url': url('products'),
+                    'route': 'products',
                     'perm': 'products.list',
                 },
                 {
                     'title': "Brands",
-                    'url': url('brands'),
+                    'route': 'brands',
                     'perm': 'brands.list',
                 },
                 {
                     'title': "Report Codes",
-                    'url': url('reportcodes'),
+                    'route': 'reportcodes',
                     'perm': 'reportcodes.list',
                 },
             ],
-        },
-        {
+        }
+
+    def make_vendors_menu(self, request, **kwargs):
+        return {
             'title': "Vendors",
             'type': 'menu',
             'items': [
                 {
                     'title': "Vendors",
-                    'url': url('vendors'),
+                    'route': 'vendors',
                     'perm': 'vendors.list',
                 },
                 {'type': 'sep'},
                 {
                     'title': "Catalogs",
-                    'url': url('vendorcatalogs'),
+                    'route': 'vendorcatalogs',
                     'perm': 'vendorcatalogs.list',
                 },
                 {
                     'title': "Upload New Catalog",
-                    'url': url('vendorcatalogs.create'),
+                    'route': 'vendorcatalogs.create',
                     'perm': 'vendorcatalogs.create',
                 },
             ],
-        },
-        {
+        }
+
+    def make_company_menu(self, request, **kwargs):
+        return {
             'title': "Company",
             'type': 'menu',
             'items': [
                 {
                     'title': "Stores",
-                    'url': url('stores'),
+                    'route': 'stores',
                     'perm': 'stores.list',
                 },
                 {
                     'title': "Departments",
-                    'url': url('departments'),
+                    'route': 'departments',
                     'perm': 'departments.list',
                 },
                 {
                     'title': "Subdepartments",
-                    'url': url('subdepartments'),
+                    'route': 'subdepartments',
                     'perm': 'subdepartments.list',
                 },
                 {'type': 'sep'},
                 {
                     'title': "Employees",
-                    'url': url('employees'),
+                    'route': 'employees',
                     'perm': 'employees.list',
                 },
                 {'type': 'sep'},
                 {
                     'title': "Customers",
-                    'url': url('customers'),
+                    'route': 'customers',
                     'perm': 'customers.list',
                 },
                 {
                     'title': "Customer Groups",
-                    'url': url('customergroups'),
+                    'route': 'customergroups',
                     'perm': 'customergroups.list',
                 },
             ],
-        },
-        {
+        }
+
+    def make_batches_menu(self, request, **kwargs):
+        return {
             'title': "Batches",
             'type': 'menu',
             'items': [
                 {
                     'title': "Handheld",
-                    'url': url('batch.handheld'),
+                    'route': 'batch.handheld',
                     'perm': 'batch.handheld.list',
                 },
                 {
                     'title': "Inventory",
-                    'url': url('batch.inventory'),
+                    'route': 'batch.inventory',
                     'perm': 'batch.inventory.list',
                 },
             ],
-        },
-        {
-            'title': "Admin",
-            'type': 'menu',
-            'items': [
-                {
-                    'title': "Users",
-                    'url': url('users'),
-                    'perm': 'users.list',
-                },
-                {
-                    'title': "User Events",
-                    'url': url('userevents'),
-                    'perm': 'userevents.list',
-                },
-                {
-                    'title': "Roles",
-                    'url': url('roles'),
-                    'perm': 'roles.list',
-                },
-                {'type': 'sep'},
-                {
-                    'title': "App Settings",
-                    'url': url('appsettings'),
-                    'perm': 'settings.list',
-                },
-                {
-                    'title': "Email Settings",
-                    'url': url('emailprofiles'),
-                    'perm': 'emailprofiles.list',
-                },
-                {
-                    'title': "Email Attempts",
-                    'url': url('email_attempts'),
-                    'perm': 'email_attempts.list',
-                },
-                {
-                    'title': "Raw Settings",
-                    'url': url('settings'),
-                    'perm': 'settings.list',
-                },
-                {'type': 'sep'},
-                {
-                    'title': "DataSync Changes",
-                    'url': url('datasyncchanges'),
-                    'perm': 'datasync.list',
-                },
-                {
-                    'title': "Tables",
-                    'url': url('tables'),
-                    'perm': 'tables.list',
-                },
-                {
-                    'title': "Rattail Tutorial Upgrades",
-                    'url': url('upgrades'),
-                    'perm': 'upgrades.list',
-                },
-            ],
-        },
-    ]
-
-    return menus
+        }