added docs for Table tags

Author: dantownsend

docs/src/piccolo/projects_and_apps/piccolo_apps.rst

@@ -105,6 +105,8 @@ auto migrations (see :ref:`Migrations`).
 You can register them manually, see the example above, or can use
 ``table_finder``.
 
+.. _TableFinder:
+
 table_finder
 ------------
 
@@ -127,6 +129,8 @@ list of modules.
 The module path should be from the root of the project (the same directory as
 your ``piccolo_conf.py`` file, rather than a relative path).
 
+You can filter the ``Table`` subclasses returned using tags (see :ref:`TableTags`).
+
 .. currentmodule:: piccolo.conf.apps
 
 .. autofunction:: table_finder
@@ -160,7 +164,7 @@ and docstrings. Here's an example:
         """
         print(name)
 
-We then register it with the `AppConfig`.
+We then register it with the ``AppConfig``.
 
 .. code-block:: python
 

docs/src/piccolo/schema/advanced.rst

@@ -47,3 +47,18 @@ Here is an example of a more complex ``Readable``.
 
 As you can see, the template can include multiple columns, and can contain your
 own text.
+
+-------------------------------------------------------------------------------
+
+.. _TableTags:
+
+Table Tags
+----------
+
+``Table`` subclasses can be given tags. The tags can be used for filtering,
+for example with ``table_finder`` (see :ref:`TableFinder`).
+
+.. code-block:: python
+
+    class Band(Table, tags=["music"]):
+        name = Varchar(length=100)

piccolo/table.py

@@ -103,6 +103,17 @@ def __init_subclass__(
         """
         Automatically populate the _meta, which includes the tablename, and
         columns.
+
+        :param tablename:
+            Specify a custom tablename. By default the classname is converted
+            to snakecase.
+        :param db:
+            Manually specify an engine to use for connecting to the database.
+            Useful when writing simple scripts. If not set, the engine is
+            imported from piccolo_conf.py using ``engine_finder``.
+        :param tags:
+            Used for filtering, for example by ``table_finder``.
+
         """
         tablename = tablename if tablename else _camel_to_snake(cls.__name__)