bluer-objects 6.235.1__py3-none-any.whl → 6.238.1__py3-none-any.whl

bluer_objects/README/functions.py

@@ -17,6 +17,7 @@ from bluer_objects.README.utils import (
     process_include,
     process_mermaid,
     process_objects,
+    process_title,
     process_variable,
     signature,
     variables,
@@ -156,6 +157,13 @@ def build(
             )
             continue
 
+        if template_line.startswith("title:::"):
+            content += process_title(
+                template_line,
+                filename,
+            )
+            continue
+
         if "help:::" in template_line:
             if help_function is None:
                 logger.warning("help_function not found.")

bluer_objects/README/utils.py

@@ -1,4 +1,5 @@
-from typing import List, Tuple, Dict, Union, Callable
+import os
+from typing import List, Dict, Union, Callable
 
 from bluer_options.env import get_env
 from bluer_objects import file
@@ -198,6 +199,33 @@ def process_objects(template_line: str) -> str:
     return template_line
 
 
+def process_title(
+    template_line: str,
+    filename: str,
+) -> List[str]:
+    template_line_pieces = [
+        piece for piece in template_line.strip().split(":::") if piece
+    ]
+    reference = template_line_pieces[1] if len(template_line_pieces) >= 2 else "docs"
+
+    filename_path_pieces = file.path(filename).split(os.sep)
+    if reference not in filename_path_pieces:
+        logger.warning(
+            "reference: {} not found in {}.".format(
+                reference,
+                template_line,
+            )
+        )
+        return ["# title: not found"]
+
+    title_pieces = filename_path_pieces[filename_path_pieces.index(reference) + 1 :]
+    filename_name = file.name(filename)
+    if filename_name != "README":
+        title_pieces.append(filename_name)
+
+    return ["# {}".format(": ".join(title_pieces))]
+
+
 def process_variable(template_line: str):
     key, value = template_line.split("set:::", 1)[1].split(" ", 1)
     variables[key] = value

bluer_objects/__init__.py

@@ -4,7 +4,7 @@ ICON = "🌀"
 
 DESCRIPTION = f"{ICON} Object management in Bash."
 
-VERSION = "6.235.1"
+VERSION = "6.238.1"
 
 REPO_NAME = "bluer-objects"
 

{bluer_objects-6.235.1.dist-info → bluer_objects-6.238.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bluer_objects
-Version: 6.235.1
+Version: 6.238.1
 Summary: 🌀 Object management in Bash.
 Home-page: https://github.com/kamangir/bluer-objects
 Author: Arash Abadpour (Kamangir)
@@ -64,6 +64,6 @@ pip install bluer-objects
 
 [![pylint](https://github.com/kamangir/bluer-objects/actions/workflows/pylint.yml/badge.svg)](https://github.com/kamangir/bluer-objects/actions/workflows/pylint.yml) [![pytest](https://github.com/kamangir/bluer-objects/actions/workflows/pytest.yml/badge.svg)](https://github.com/kamangir/bluer-objects/actions/workflows/pytest.yml) [![bashtest](https://github.com/kamangir/bluer-objects/actions/workflows/bashtest.yml/badge.svg)](https://github.com/kamangir/bluer-objects/actions/workflows/bashtest.yml) [![PyPI version](https://img.shields.io/pypi/v/bluer-objects.svg)](https://pypi.org/project/bluer-objects/) [![PyPI - Downloads](https://img.shields.io/pypi/dd/bluer-objects)](https://pypistats.org/packages/bluer-objects)
 
-built by 🌀 [`bluer README`](https://github.com/kamangir/bluer-objects/tree/main/bluer_objects/README), based on 🌀 [`bluer_objects-6.235.1`](https://github.com/kamangir/bluer-objects).
+built by 🌀 [`bluer README`](https://github.com/kamangir/bluer-objects/tree/main/bluer_objects/README), based on 🌀 [`bluer_objects-6.238.1`](https://github.com/kamangir/bluer-objects).
 
 built by 🌀 [`blueness-3.118.1`](https://github.com/kamangir/blueness).

{bluer_objects-6.235.1.dist-info → bluer_objects-6.238.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-bluer_objects/__init__.py,sha256=ofPRcFSzDjaruJ-HFoqSQgBIZQ-3WndwUqgbApttPa8,315
+bluer_objects/__init__.py,sha256=zySDgQgSGkUNDZxMrX2hcYi9nzeo0V6Uxfb-9suEvok,315
 bluer_objects/__main__.py,sha256=Yqfov833_hJuRne19WrGhT5DWAPtdffpoMxeSXS7EGw,359
 bluer_objects/config.env,sha256=RjcpnbKfRqNyGLRB4z7M_OG9z2pOM032ck__53JqXqo,216
 bluer_objects/env.py,sha256=iw4QvaImqnavlsHwfkUScNHc7afDEJQKJSsHTtVJE78,2019
@@ -72,9 +72,9 @@ bluer_objects/.abcli/tests/web_where_am_ai.sh,sha256=BJ9G_m4id8cx_UB_l_jV2xY6AfQ
 bluer_objects/.abcli/web/is_accessible.sh,sha256=Luv_6IvpscRYx7f39V0RnkkNEWTRfVGyQVUeij3iqa0,262
 bluer_objects/.abcli/web/where_am_i.sh,sha256=QPBXFo6Ni4pZEoOx0rtuJUxk6tOlp0ESMyAc9YPy9zg,92
 bluer_objects/README/__init__.py,sha256=JwxdTVAK3LeUaw7rMJujOFIXZA59HaLCtxpsR1C-vpo,1311
-bluer_objects/README/functions.py,sha256=JPr7kkBTwC8xbZptxDSUeey8PoHYCfssu3wuaff_S2k,5390
+bluer_objects/README/functions.py,sha256=4GUp3gRlfvAyOiaVxbdy7RF8i-Jwz2LjTEYe7jf-lxI,5589
 bluer_objects/README/items.py,sha256=rTiOVd9fCoKUbFofBWjRV6oNDaH3XXdpL0XIPZqpy_w,951
-bluer_objects/README/utils.py,sha256=oZysOe-184SXz0yX_C8M_roTJ4wC8VRdyLpAezM0qb4,7139
+bluer_objects/README/utils.py,sha256=HYH7P5quJpZcT8HRSUe1lub9mmwSIyQwbeGm2IX_SOQ,7975
 bluer_objects/file/__init__.py,sha256=c_79ipBkKl6OFDimOev0vnaVdpUk-Bl3oJUapOreMXc,681
 bluer_objects/file/__main__.py,sha256=v2IXWvZeh_B2sGYWzv1CiUY-7HWHXXghZM5M4IPjbu4,1277
 bluer_objects/file/classes.py,sha256=TRgeRP2yxInPkBnywhuB4BsoBcBRA3UmQzX1dI43UxU,872
@@ -171,8 +171,8 @@ bluer_objects/tests/test_web_is_accessible.py,sha256=2Y20NAEDMblg0MKnhnqcfw3XVKE
 bluer_objects/web/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 bluer_objects/web/__main__.py,sha256=xf2Ob54FI8JEokfGhFmiyOBdD9nBactwqmZvsKsdioU,624
 bluer_objects/web/functions.py,sha256=KNufAFOc6N3BYf83lN2rUpKUdsnzb2anWyp9koFRVUo,172
-bluer_objects-6.235.1.dist-info/licenses/LICENSE,sha256=ogEPNDSH0_dhiv_lT3ifVIdgIzHAqNA_SemnxUfPBJk,7048
-bluer_objects-6.235.1.dist-info/METADATA,sha256=ZhAeBF4uFx-GsQRqsb6RjigVYDjEKbouqpt6JTD3juo,3678
-bluer_objects-6.235.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-bluer_objects-6.235.1.dist-info/top_level.txt,sha256=RX2TpddbnRkurda3G_pAdyeTztP2IhhRPx949GlEvQo,14
-bluer_objects-6.235.1.dist-info/RECORD,,
+bluer_objects-6.238.1.dist-info/licenses/LICENSE,sha256=ogEPNDSH0_dhiv_lT3ifVIdgIzHAqNA_SemnxUfPBJk,7048
+bluer_objects-6.238.1.dist-info/METADATA,sha256=c4f_mnFSjKG7LXtqUKKFL0moEk3wDyhzzpX_U2shsGU,3678
+bluer_objects-6.238.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+bluer_objects-6.238.1.dist-info/top_level.txt,sha256=RX2TpddbnRkurda3G_pAdyeTztP2IhhRPx949GlEvQo,14
+bluer_objects-6.238.1.dist-info/RECORD,,