From dad39f65b1692b1789be0425e0ae4a859e039e24 Mon Sep 17 00:00:00 2001
From:  <>
Date: Tue, 23 Nov 2021 20:57:41 +0000
Subject: [PATCH] Deployed f64087e with MkDocs version: 1.2.3

---
 coverage/d_678a5ac99edfd408__version_py.html |   2 +-
 coverage/status.json                         |   2 +-
 home/changelog/index.html                    | 127 ++++++-------------
 search/search_index.json                     |   2 +-
 sitemap.xml.gz                               | Bin 326 -> 326 bytes
 5 files changed, 44 insertions(+), 89 deletions(-)

diff --git a/coverage/d_678a5ac99edfd408__version_py.html b/coverage/d_678a5ac99edfd408__version_py.html
index 53bf630..edd6a8f 100644
--- a/coverage/d_678a5ac99edfd408__version_py.html
+++ b/coverage/d_678a5ac99edfd408__version_py.html
@@ -59,7 +59,7 @@
 <main id="source">
     <p class="pln"><span class="n"><a id="t1" href="#t1">1</a></span><span class="t"><span class="str">"""Module containing the version of tembo."""</span>&nbsp;</span><span class="r"></span></p>
     <p class="pln"><span class="n"><a id="t2" href="#t2">2</a></span><span class="t">&nbsp;</span><span class="r"></span></p>
-    <p class="run"><span class="n"><a id="t3" href="#t3">3</a></span><span class="t"><span class="nam">__version__</span> <span class="op">=</span> <span class="str">"1.0.2"</span>&nbsp;</span><span class="r"></span></p>
+    <p class="run"><span class="n"><a id="t3" href="#t3">3</a></span><span class="t"><span class="nam">__version__</span> <span class="op">=</span> <span class="str">"1.0.1"</span>&nbsp;</span><span class="r"></span></p>
 </main>
 <footer>
     <div class="content">
diff --git a/coverage/status.json b/coverage/status.json
index ed7f20e..e0100e8 100644
--- a/coverage/status.json
+++ b/coverage/status.json
@@ -1 +1 @@
-{"format":2,"version":"6.1.2","globals":"c749f05b6072c4945ea4ece5d6d66c66","files":{"d_678a5ac99edfd408___init___py":{"hash":"a99bebc8a6ed6eb80f162815ae7bea72","index":{"nums":[0,1,2,0,0,0,0,0],"html_filename":"d_678a5ac99edfd408___init___py.html","relative_filename":"tembo/__init__.py"}},"d_678a5ac99edfd408___main___py":{"hash":"5002cd4aaebac8e3448a5e7c0f46fc3a","index":{"nums":[0,1,4,0,4,0,0,0],"html_filename":"d_678a5ac99edfd408___main___py.html","relative_filename":"tembo/__main__.py"}},"d_678a5ac99edfd408__version_py":{"hash":"8aee68120d9d33287588351458f936be","index":{"nums":[0,1,1,0,0,0,0,0],"html_filename":"d_678a5ac99edfd408__version_py.html","relative_filename":"tembo/_version.py"}},"d_2b703ede0196a3c0___init___py":{"hash":"3c1d021cb567ab0a155fff32d88fd635","index":{"nums":[0,1,19,0,5,0,0,0],"html_filename":"d_2b703ede0196a3c0___init___py.html","relative_filename":"tembo/cli/__init__.py"}},"d_2b703ede0196a3c0_cli_py":{"hash":"c0d0261821eb13d7f53779685ba8fa25","index":{"nums":[0,1,95,0,0,0,0,0],"html_filename":"d_2b703ede0196a3c0_cli_py.html","relative_filename":"tembo/cli/cli.py"}},"d_678a5ac99edfd408_exceptions_py":{"hash":"4abb389e11887aefc532fcdb0f8c62f5","index":{"nums":[0,1,12,0,0,0,0,0],"html_filename":"d_678a5ac99edfd408_exceptions_py.html","relative_filename":"tembo/exceptions.py"}},"d_e89a57001f83f3a6___init___py":{"hash":"7b454d07a69ae8e77062f31b080fcce4","index":{"nums":[0,1,1,0,0,0,0,0],"html_filename":"d_e89a57001f83f3a6___init___py.html","relative_filename":"tembo/journal/__init__.py"}},"d_e89a57001f83f3a6_pages_py":{"hash":"1d68a702c0314fbc06b610fc955a682f","index":{"nums":[0,1,141,6,2,0,0,0],"html_filename":"d_e89a57001f83f3a6_pages_py.html","relative_filename":"tembo/journal/pages.py"}},"d_9c7e16c5deec493b___init___py":{"hash":"f12bd9d58abb6caa9e29777c2dc5ac8e","index":{"nums":[0,1,4,0,0,0,0,0],"html_filename":"d_9c7e16c5deec493b___init___py.html","relative_filename":"tembo/utils/__init__.py"}}}}
\ No newline at end of file
+{"format":2,"version":"6.1.2","globals":"c749f05b6072c4945ea4ece5d6d66c66","files":{"d_678a5ac99edfd408___init___py":{"hash":"a99bebc8a6ed6eb80f162815ae7bea72","index":{"nums":[0,1,2,0,0,0,0,0],"html_filename":"d_678a5ac99edfd408___init___py.html","relative_filename":"tembo/__init__.py"}},"d_678a5ac99edfd408___main___py":{"hash":"5002cd4aaebac8e3448a5e7c0f46fc3a","index":{"nums":[0,1,4,0,4,0,0,0],"html_filename":"d_678a5ac99edfd408___main___py.html","relative_filename":"tembo/__main__.py"}},"d_678a5ac99edfd408__version_py":{"hash":"15e46fbe4becea98e7345a593be20466","index":{"nums":[0,1,1,0,0,0,0,0],"html_filename":"d_678a5ac99edfd408__version_py.html","relative_filename":"tembo/_version.py"}},"d_2b703ede0196a3c0___init___py":{"hash":"3c1d021cb567ab0a155fff32d88fd635","index":{"nums":[0,1,19,0,5,0,0,0],"html_filename":"d_2b703ede0196a3c0___init___py.html","relative_filename":"tembo/cli/__init__.py"}},"d_2b703ede0196a3c0_cli_py":{"hash":"c0d0261821eb13d7f53779685ba8fa25","index":{"nums":[0,1,95,0,0,0,0,0],"html_filename":"d_2b703ede0196a3c0_cli_py.html","relative_filename":"tembo/cli/cli.py"}},"d_678a5ac99edfd408_exceptions_py":{"hash":"4abb389e11887aefc532fcdb0f8c62f5","index":{"nums":[0,1,12,0,0,0,0,0],"html_filename":"d_678a5ac99edfd408_exceptions_py.html","relative_filename":"tembo/exceptions.py"}},"d_e89a57001f83f3a6___init___py":{"hash":"7b454d07a69ae8e77062f31b080fcce4","index":{"nums":[0,1,1,0,0,0,0,0],"html_filename":"d_e89a57001f83f3a6___init___py.html","relative_filename":"tembo/journal/__init__.py"}},"d_e89a57001f83f3a6_pages_py":{"hash":"1d68a702c0314fbc06b610fc955a682f","index":{"nums":[0,1,141,6,2,0,0,0],"html_filename":"d_e89a57001f83f3a6_pages_py.html","relative_filename":"tembo/journal/pages.py"}},"d_9c7e16c5deec493b___init___py":{"hash":"f12bd9d58abb6caa9e29777c2dc5ac8e","index":{"nums":[0,1,4,0,0,0,0,0],"html_filename":"d_9c7e16c5deec493b___init___py.html","relative_filename":"tembo/utils/__init__.py"}}}}
\ No newline at end of file
diff --git a/home/changelog/index.html b/home/changelog/index.html
index e23dd6a..c9bb12c 100644
--- a/home/changelog/index.html
+++ b/home/changelog/index.html
@@ -394,20 +394,13 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#v102-2021-11-23" class="md-nav__link">
-    v1.0.2 - 2021-11-23
+  <a href="#101-2021-11-21" class="md-nav__link">
+    1.0.1 - 2021-11-21
   </a>
   
-    <nav class="md-nav" aria-label="v1.0.2 - 2021-11-23">
+    <nav class="md-nav" aria-label="1.0.1 - 2021-11-21">
       <ul class="md-nav__list">
         
-          <li class="md-nav__item">
-  <a href="#features" class="md-nav__link">
-    Features
-  </a>
-  
-</li>
-        
           <li class="md-nav__item">
   <a href="#miscellaneous-tasks" class="md-nav__link">
     Miscellaneous Tasks
@@ -421,11 +414,11 @@
 </li>
       
         <li class="md-nav__item">
-  <a href="#v101-2021-11-21" class="md-nav__link">
-    v1.0.1 - 2021-11-21
+  <a href="#100-2021-11-21" class="md-nav__link">
+    1.0.0 - 2021-11-21
   </a>
   
-    <nav class="md-nav" aria-label="v1.0.1 - 2021-11-21">
+    <nav class="md-nav" aria-label="1.0.0 - 2021-11-21">
       <ul class="md-nav__list">
         
           <li class="md-nav__item">
@@ -435,31 +428,18 @@
   
 </li>
         
-      </ul>
-    </nav>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#v100-2021-11-21" class="md-nav__link">
-    v1.0.0 - 2021-11-21
-  </a>
-  
-    <nav class="md-nav" aria-label="v1.0.0 - 2021-11-21">
-      <ul class="md-nav__list">
-        
           <li class="md-nav__item">
-  <a href="#documentation_1" class="md-nav__link">
-    Documentation
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#features_1" class="md-nav__link">
+  <a href="#features" class="md-nav__link">
     Features
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#miscellaneous-tasks_1" class="md-nav__link">
+    Miscellaneous Tasks
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -886,20 +866,13 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#v102-2021-11-23" class="md-nav__link">
-    v1.0.2 - 2021-11-23
+  <a href="#101-2021-11-21" class="md-nav__link">
+    1.0.1 - 2021-11-21
   </a>
   
-    <nav class="md-nav" aria-label="v1.0.2 - 2021-11-23">
+    <nav class="md-nav" aria-label="1.0.1 - 2021-11-21">
       <ul class="md-nav__list">
         
-          <li class="md-nav__item">
-  <a href="#features" class="md-nav__link">
-    Features
-  </a>
-  
-</li>
-        
           <li class="md-nav__item">
   <a href="#miscellaneous-tasks" class="md-nav__link">
     Miscellaneous Tasks
@@ -913,11 +886,11 @@
 </li>
       
         <li class="md-nav__item">
-  <a href="#v101-2021-11-21" class="md-nav__link">
-    v1.0.1 - 2021-11-21
+  <a href="#100-2021-11-21" class="md-nav__link">
+    1.0.0 - 2021-11-21
   </a>
   
-    <nav class="md-nav" aria-label="v1.0.1 - 2021-11-21">
+    <nav class="md-nav" aria-label="1.0.0 - 2021-11-21">
       <ul class="md-nav__list">
         
           <li class="md-nav__item">
@@ -927,31 +900,18 @@
   
 </li>
         
-      </ul>
-    </nav>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#v100-2021-11-21" class="md-nav__link">
-    v1.0.0 - 2021-11-21
-  </a>
-  
-    <nav class="md-nav" aria-label="v1.0.0 - 2021-11-21">
-      <ul class="md-nav__list">
-        
           <li class="md-nav__item">
-  <a href="#documentation_1" class="md-nav__link">
-    Documentation
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#features_1" class="md-nav__link">
+  <a href="#features" class="md-nav__link">
     Features
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#miscellaneous-tasks_1" class="md-nav__link">
+    Miscellaneous Tasks
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -985,34 +945,29 @@
                 
                 <h1 id="changelog">Changelog<a class="headerlink" href="#changelog" title="Permanent link">¤</a></h1>
 <p>All notable changes to this project will be documented in this file.</p>
-<!-- marker -->
-<h2 id="v102-2021-11-23"><a href="https://github.com/tembo-pages/tembo-core/commits/v1.0.2">v1.0.2</a> - 2021-11-23<a class="headerlink" href="#v102-2021-11-23" title="Permanent link">¤</a></h2>
-<p><small><a href="https://github.com/tembo-pages/tembo-core/compare/v1.0.1..v1.0.2">Compare with v1.0.1</a></small></p>
-<h3 id="features">Features<a class="headerlink" href="#features" title="Permanent link">¤</a></h3>
-<ul>
-<li>Add garbage (<a href="https://github.com/tembo-pages/tembo-core/commit/b49d776712737deaa1aeb86dd40230c099198d5a">b49d77</a>)</li>
-</ul>
+<p>The format is based on <a href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>,
+and this project adheres to <a href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
+<h2 id="101-2021-11-21"><a href="https://github.com/tembo-pages/tembo-core/commits/1.0.1">1.0.1</a> - 2021-11-21<a class="headerlink" href="#101-2021-11-21" title="Permanent link">¤</a></h2>
+<p><small><a href="https://github.com/tembo-pages/tembo-core/compare/v1.0.1...v1.0.0">Compare with v1.0.0</a></small></p>
 <h3 id="miscellaneous-tasks">Miscellaneous Tasks<a class="headerlink" href="#miscellaneous-tasks" title="Permanent link">¤</a></h3>
 <ul>
-<li>Prepare release v1.0.2 (<a href="https://github.com/tembo-pages/tembo-core/commit/e29ae6dadb1ca419d536db18f34d9d249012cc25">e29ae6</a>)</li>
-<li>Update cliff.toml (<a href="https://github.com/tembo-pages/tembo-core/commit/7ee36f28b5160251c37085744166c2a5b1e695e4">7ee36f</a>)</li>
-<li>Update duties.py with latest changelog duty (<a href="https://github.com/tembo-pages/tembo-core/commit/f6f2fe07b61e8fa8bd812bbc63a51d3f9705a448">f6f2fe</a>)</li>
+<li>Add changelog generation using git-cliff (<a href="https://github.com/tembo-pages/tembo-core/commit/4c8d686abb82ade97680a3e8cdef267559282ff4">4c8d68</a>)</li>
+<li>Prepare release 1.0.1 (<a href="https://github.com/tembo-pages/tembo-core/commit/b077aaaf6666e78507f6439fa2e10a34c55176e5">b077aa</a>)</li>
 </ul>
-<h2 id="v101-2021-11-21"><a href="https://github.com/tembo-pages/tembo-core/commits/v1.0.1">v1.0.1</a> - 2021-11-21<a class="headerlink" href="#v101-2021-11-21" title="Permanent link">¤</a></h2>
-<p><small><a href="https://github.com/tembo-pages/tembo-core/compare/v1.0.0..v1.0.1">Compare with v1.0.0</a></small></p>
+<h2 id="100-2021-11-21"><a href="https://github.com/tembo-pages/tembo-core/commits/v1.0.0">1.0.0</a> - 2021-11-21<a class="headerlink" href="#100-2021-11-21" title="Permanent link">¤</a></h2>
 <h3 id="documentation">Documentation<a class="headerlink" href="#documentation" title="Permanent link">¤</a></h3>
 <ul>
-<li>Update changelog (<a href="https://github.com/tembo-pages/tembo-core/commit/b710338a73add7ed93af1f76f3b9272e30ce41de">b71033</a>)</li>
-</ul>
-<h2 id="v100-2021-11-21"><a href="https://github.com/tembo-pages/tembo-core/commits/v1.0.0">v1.0.0</a> - 2021-11-21<a class="headerlink" href="#v100-2021-11-21" title="Permanent link">¤</a></h2>
-<h3 id="documentation_1">Documentation<a class="headerlink" href="#documentation_1" title="Permanent link">¤</a></h3>
-<ul>
 <li>Update changelog (<a href="https://github.com/tembo-pages/tembo-core/commit/26fe8118649bbff109233a80130a7323539f256f">26fe81</a>)</li>
 </ul>
-<h3 id="features_1">Features<a class="headerlink" href="#features_1" title="Permanent link">¤</a></h3>
+<h3 id="features">Features<a class="headerlink" href="#features" title="Permanent link">¤</a></h3>
 <ul>
 <li>Initial commit (<a href="https://github.com/tembo-pages/tembo-core/commit/fb7fec7ea619318b0e0830c0f9260335c0d4e173">fb7fec</a>)</li>
 </ul>
+<h3 id="miscellaneous-tasks_1">Miscellaneous Tasks<a class="headerlink" href="#miscellaneous-tasks_1" title="Permanent link">¤</a></h3>
+<ul>
+<li>Update duties.py (<a href="https://github.com/tembo-pages/tembo-core/commit/562de606c4846ad37d32822260121892c353e7ca">562de6</a>)</li>
+<li>Prepare release 1.0.0 (<a href="https://github.com/tembo-pages/tembo-core/commit/eed47d34b9a0b79f48b2fbe0ad77f43dc42f6027">eed47d</a>)</li>
+</ul>
 <h3 id="build">Build<a class="headerlink" href="#build" title="Permanent link">¤</a></h3>
 <ul>
 <li>Update panaetius to 2.3.3 (<a href="https://github.com/tembo-pages/tembo-core/commit/e5d2b28252b9d7962a8d49d4da37b9f9c4f6d514">e5d2b2</a>)</li>
diff --git a/search/search_index.json b/search/search_index.json
index e4d9bd9..4fc03e1 100644
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Tembo \u00a4 from tembo import Success v0.0.8","title":"Overview"},{"location":"#tembo","text":"from tembo import Success v0.0.8","title":"Tembo"},{"location":"cli_reference/main/","text":"CLI Reference \u00a4 tembo \u00a4 Tembo - an organiser for work notes. Usage: tembo <options> COMMAND [ARGS]... Options: Name Type Description Default -v , --version boolean Show the version and exit. False --help boolean Show this message and exit. False list \u00a4 List all scopes defined in the config.yml. Usage: tembo list <options> Options: Name Type Description Default --help boolean Show this message and exit. False new \u00a4 Create a new page. <scope> The name of the scope in the config.yml. <inputs> Any input token values that are defined in the config.yml for this scope. Accepts multiple inputs separated by a space. Example: tembo new meeting my_presentation Usage: tembo new <options> <scope> <inputs> Options: Name Type Description Default --dry-run boolean Show the full path of the page to be created without actually saving the page to disk and exit. False --example boolean Show the example command in the config.yml if it exists and exit. False --help boolean Show this message and exit. False","title":"tembo"},{"location":"cli_reference/main/#cli-reference","text":"","title":"CLI Reference"},{"location":"cli_reference/main/#tembo","text":"Tembo - an organiser for work notes. Usage: tembo <options> COMMAND [ARGS]... Options: Name Type Description Default -v , --version boolean Show the version and exit. False --help boolean Show this message and exit. False","title":"tembo"},{"location":"cli_reference/main/#list","text":"List all scopes defined in the config.yml. Usage: tembo list <options> Options: Name Type Description Default --help boolean Show this message and exit. False","title":"list"},{"location":"cli_reference/main/#new","text":"Create a new page. <scope> The name of the scope in the config.yml. <inputs> Any input token values that are defined in the config.yml for this scope. Accepts multiple inputs separated by a space. Example: tembo new meeting my_presentation Usage: tembo new <options> <scope> <inputs> Options: Name Type Description Default --dry-run boolean Show the full path of the page to be created without actually saving the page to disk and exit. False --example boolean Show the example command in the config.yml if it exists and exit. False --help boolean Show this message and exit. False","title":"new"},{"location":"code_reference/SUMMARY/","text":"__init__.py __main__.py _version.py cli __init__.py cli.py exceptions.py journal __init__.py pages.py utils __init__.py","title":"SUMMARY"},{"location":"code_reference/__init__/","text":"Tembo package. A simple folder organiser for your work notes.","title":"__init__.py"},{"location":"code_reference/__main__/","text":"Entrypoint module. Used when using python -m tembo to invoke the CLI.","title":"__main__.py"},{"location":"code_reference/_version/","text":"Module containing the version of tembo.","title":"_version.py"},{"location":"code_reference/exceptions/","text":"Module containing custom exceptions. BasePathDoesNotExistError ( Exception ) \u00a4 Raised if the base path does not exist. EmptyConfigYML ( Exception ) \u00a4 Raised if the config.yml file is empty. MandatoryKeyNotFound ( Exception ) \u00a4 Raised if a mandatory key is not found in the config.yml. MismatchedTokenError ( Exception ) \u00a4 Raised when the number of input tokens does not match the user config. Attributes: Name Type Description expected int number of input tokens in the user config. given int number of input tokens passed in. __init__ ( self , expected , given ) special \u00a4 Initialise the exception. Parameters: Name Type Description Default expected int number of input tokens in the user config. required given int number of input tokens passed in. required Source code in tembo/exceptions.py def __init__ ( self , expected : int , given : int ) -> None : \"\"\" Initialise the exception. Args: expected (int): number of input tokens in the user config. given (int): number of input tokens passed in. \"\"\" self . expected = expected self . given = given super () . __init__ () MissingConfigYML ( Exception ) \u00a4 Raised if the config.yml file is missing. ScopeNotFound ( Exception ) \u00a4 Raised if the scope does not exist in the config.yml. ScopedPageAlreadyExists ( Exception ) \u00a4 Raised if the scoped page file already exists. TemplateFileNotFoundError ( Exception ) \u00a4 Raised if the template file does not exist.","title":"exceptions.py"},{"location":"code_reference/exceptions/#tembo.exceptions.BasePathDoesNotExistError","text":"Raised if the base path does not exist.","title":"BasePathDoesNotExistError"},{"location":"code_reference/exceptions/#tembo.exceptions.EmptyConfigYML","text":"Raised if the config.yml file is empty.","title":"EmptyConfigYML"},{"location":"code_reference/exceptions/#tembo.exceptions.MandatoryKeyNotFound","text":"Raised if a mandatory key is not found in the config.yml.","title":"MandatoryKeyNotFound"},{"location":"code_reference/exceptions/#tembo.exceptions.MismatchedTokenError","text":"Raised when the number of input tokens does not match the user config. Attributes: Name Type Description expected int number of input tokens in the user config. given int number of input tokens passed in.","title":"MismatchedTokenError"},{"location":"code_reference/exceptions/#tembo.exceptions.MismatchedTokenError.__init__","text":"Initialise the exception. Parameters: Name Type Description Default expected int number of input tokens in the user config. required given int number of input tokens passed in. required Source code in tembo/exceptions.py def __init__ ( self , expected : int , given : int ) -> None : \"\"\" Initialise the exception. Args: expected (int): number of input tokens in the user config. given (int): number of input tokens passed in. \"\"\" self . expected = expected self . given = given super () . __init__ ()","title":"__init__()"},{"location":"code_reference/exceptions/#tembo.exceptions.MissingConfigYML","text":"Raised if the config.yml file is missing.","title":"MissingConfigYML"},{"location":"code_reference/exceptions/#tembo.exceptions.ScopeNotFound","text":"Raised if the scope does not exist in the config.yml.","title":"ScopeNotFound"},{"location":"code_reference/exceptions/#tembo.exceptions.ScopedPageAlreadyExists","text":"Raised if the scoped page file already exists.","title":"ScopedPageAlreadyExists"},{"location":"code_reference/exceptions/#tembo.exceptions.TemplateFileNotFoundError","text":"Raised if the template file does not exist.","title":"TemplateFileNotFoundError"},{"location":"code_reference/cli/__init__/","text":"Subpackage that contains the CLI application.","title":"__init__.py"},{"location":"code_reference/cli/cli/","text":"Submodule which contains the CLI implementation using Click. cli_message ( message ) \u00a4 Relay a message to the user using the CLI. Parameters: Name Type Description Default message str THe message to be displayed. required Source code in tembo/cli/cli.py def cli_message ( message : str ) -> None : \"\"\" Relay a message to the user using the CLI. Args: message (str): THe message to be displayed. \"\"\" click . echo ( f \"[TEMBO] { message } \ud83d\udc18\" )","title":"cli.py"},{"location":"code_reference/cli/cli/#tembo.cli.cli.cli_message","text":"Relay a message to the user using the CLI. Parameters: Name Type Description Default message str THe message to be displayed. required Source code in tembo/cli/cli.py def cli_message ( message : str ) -> None : \"\"\" Relay a message to the user using the CLI. Args: message (str): THe message to be displayed. \"\"\" click . echo ( f \"[TEMBO] { message } \ud83d\udc18\" )","title":"cli_message()"},{"location":"code_reference/journal/__init__/","text":"Subpackage containing the logic to create Tembo journals & pages.","title":"__init__.py"},{"location":"code_reference/journal/pages/","text":"Submodule containing the factories & page objects to create Tembo pages. Page \u00a4 Abstract Page class. This interface is used to define a Page object. A Page represents a note/page that will be saved to disk. Abstract This object is an abstract base class and should be implemented for each Page type. path : pathlib . Path property readonly \u00a4 When implemented this should return the full path of the page including the filename. Returns: Type Description pathlib.Path the path as a Path object. Abstract This property is abstract and should be implemented for each Page type. __init__ ( self , path , page_content ) special \u00a4 When implemented this should initalise a Page object. Parameters: Name Type Description Default path pathlib.Path the full path of the page including the filename as a Path . required page_content str the contents of the page. required Abstract This method is abstract and should be implemented for each Page type. Source code in tembo/journal/pages.py @abstractmethod def __init__ ( self , path : pathlib . Path , page_content : str ) -> None : \"\"\" When implemented this should initalise a Page object. Args: path (pathlib.Path): the full path of the page including the filename as a [Path][pathlib.Path]. page_content (str): the contents of the page. !!! abstract This method is abstract and should be implemented for each `Page` type. \"\"\" raise NotImplementedError save_to_disk ( self ) \u00a4 When implemented this should save the page to disk. Returns: Type Description tembo.utils.Success A Tembo Success object. Abstract This method is abstract and should be implemented for each Page type. Source code in tembo/journal/pages.py @abstractmethod def save_to_disk ( self ) -> tembo . utils . Success : \"\"\" When implemented this should save the page to disk. Returns: tembo.utils.Success: A Tembo [Success][tembo.utils.__init__.Success] object. !!! abstract This method is abstract and should be implemented for each `Page` type. \"\"\" raise NotImplementedError PageCreator \u00a4 A PageCreator factory base class. This factory should implement methods to create Page objects. Abstract This factory is an abstract base class and should be implemented for each Page type. The private methods _check_base_path_exists() _convert_base_path_to_path() _load_template() are not abstract and are shared between all Page types. options : PageCreatorOptions property readonly \u00a4 When implemented this should return the PageCreatorOptions on the class. Returns: Type Description PageCreatorOptions the instance of PageCreatorOptions set on the class. Abstract This method is abstract and should be implemented for each Page type. __init__ ( self , options ) special \u00a4 When implemented this should initialise the PageCreator factory. Parameters: Name Type Description Default options PageCreatorOptions An instance of PageCreatorOptions required Abstract This method is abstract and should be implemented for each Page type. Source code in tembo/journal/pages.py @abstractmethod def __init__ ( self , options : PageCreatorOptions ) -> None : \"\"\" When implemented this should initialise the `PageCreator` factory. Args: options (PageCreatorOptions): An instance of [PageCreatorOptions][tembo.journal.pages.PageCreatorOptions] !!! abstract This method is abstract and should be implemented for each [Page][tembo.journal.pages.Page] type. \"\"\" raise NotImplementedError create_page ( self ) \u00a4 When implemented this should create a Page object. Returns: Type Description Page an implemented instance of Page such as ScopedPage . Abstract This method is abstract and should be implemented for each Page type. Source code in tembo/journal/pages.py @abstractmethod def create_page ( self ) -> Page : \"\"\" When implemented this should create a `Page` object. Returns: Page: an implemented instance of [Page][tembo.journal.pages.Page] such as [ScopedPage][tembo.journal.pages.ScopedPage]. !!! abstract This method is abstract and should be implemented for each [Page][tembo.journal.pages.Page] type. \"\"\" raise NotImplementedError PageCreatorOptions dataclass \u00a4 Options dataclass to create a Page. This is passed to an implemented instance of PageCreator Attributes: Name Type Description base_path str The base path. page_path str The path of the page relative to the base path. filename str The filename of the page. extension str The extension of the page. name str The name of the scope. user_input Collection[str] | None User input tokens. example str | None User example command. template_path str | None The path which contains the templates. This should be the full path and not relative to the base path. template_filename str | None The template filename with extension relative to the template path. ScopedPage ( Page ) \u00a4 A page that uses substitute tokens. Attributes: Name Type Description path pathlib.Path a Path object of the page's filepath including the filename. page_content str the content of the page from the template. path : pathlib . Path property readonly \u00a4 Return the full path of the page. Returns: Type Description pathlib.path The full path of the page as a Path object. __init__ ( self , path , page_content ) special \u00a4 Initalise a scoped page object. Parameters: Name Type Description Default path pathlib.Path a Path object of the page's filepath including the filename. required page_content str the content of the page from the template. required Source code in tembo/journal/pages.py def __init__ ( self , path : pathlib . Path , page_content : str ) -> None : \"\"\" Initalise a scoped page object. Args: path (pathlib.Path): a [Path][pathlib.Path] object of the page's filepath including the filename. page_content (str): the content of the page from the template. \"\"\" self . _path = path self . page_content = page_content __str__ ( self ) special \u00a4 Return a str representation of a ScopedPage . Examples: >>> str(ScopedPage(Path(\"/home/bob/tembo/meetings/my_meeting_0.md\"), \"\")) ScopedPage(\"/home/bob/tembo/meetings/my_meeting_0.md\") Returns: Type Description str The ScopedPage as a str . Source code in tembo/journal/pages.py def __str__ ( self ) -> str : \"\"\" Return a `str` representation of a `ScopedPage`. Examples: ``` >>> str(ScopedPage(Path(\"/home/bob/tembo/meetings/my_meeting_0.md\"), \"\")) ScopedPage(\"/home/bob/tembo/meetings/my_meeting_0.md\") ``` Returns: str: The `ScopedPage` as a `str`. \"\"\" return f 'ScopedPage(\" { self . path } \")' save_to_disk ( self ) \u00a4 Save the scoped page to disk and write the page_content . Exceptions: Type Description exceptions.ScopedPageAlreadyExists If the page already exists a ScopedPageAlreadyExists exception is raised. Returns: Type Description tembo.utils.Success A Success with the path of the ScopedPage as the message. Source code in tembo/journal/pages.py def save_to_disk ( self ) -> tembo . utils . Success : \"\"\" Save the scoped page to disk and write the `page_content`. Raises: exceptions.ScopedPageAlreadyExists: If the page already exists a [ScopedPageAlreadyExists][tembo.exceptions.ScopedPageAlreadyExists] exception is raised. Returns: tembo.utils.Success: A [Success][tembo.utils.__init__.Success] with the path of the ScopedPage as the message. \"\"\" # create the parent directories scoped_page_file = pathlib . Path ( self . path ) scoped_page_file . parents [ 0 ] . mkdir ( parents = True , exist_ok = True ) if scoped_page_file . exists (): raise exceptions . ScopedPageAlreadyExists ( f \" { self . path } already exists\" ) with scoped_page_file . open ( \"w\" , encoding = \"utf-8\" ) as scoped_page : scoped_page . write ( self . page_content ) return tembo . utils . Success ( str ( self . path )) ScopedPageCreator ( PageCreator ) \u00a4 Factory to create a scoped page. Attributes: Name Type Description base_path str base path of tembo. page_path str path of the page relative to the base path. filename str filename relative to the page path. extension str extension of file. options : PageCreatorOptions property readonly \u00a4 Return the PageCreatorOptions instance set on the factory. Returns: Type Description PageCreatorOptions An instance of PageCreatorOptions . __init__ ( self , options ) special \u00a4 Initialise a ScopedPageCreator factory. Parameters: Name Type Description Default options PageCreatorOptions An instance of PageCreatorOptions . required Source code in tembo/journal/pages.py def __init__ ( self , options : PageCreatorOptions ) -> None : \"\"\" Initialise a `ScopedPageCreator` factory. Args: options (PageCreatorOptions): An instance of [PageCreatorOptions][tembo.journal.pages.PageCreatorOptions]. \"\"\" self . _all_input_tokens : list [ str ] = [] self . _options = options create_page ( self ) \u00a4 Create a ScopedPage object. This method will Check the base_path exists Verify the input tokens match the number defined in the config.yml Substitue the input tokens in the filepath Load the template contents and substitue the input tokens Exceptions: Type Description exceptions.MismatchedTokenError Raises MismatchedTokenError if the number of input tokens does not match the number of unique input tokens defined. exceptions.BasePathDoesNotExistError Raises BasePathDoesNotExistError if the base path does not exist. exceptions.TemplateFileNotFoundError Raises TemplateFileNotFoundError if the template file is specified but not found. Returns: Type Description Page A ScopedPage object using the PageCreatorOptions . Source code in tembo/journal/pages.py def create_page ( self ) -> Page : \"\"\" Create a [ScopedPage][tembo.journal.pages.ScopedPage] object. This method will - Check the `base_path` exists - Verify the input tokens match the number defined in the `config.yml` - Substitue the input tokens in the filepath - Load the template contents and substitue the input tokens Raises: exceptions.MismatchedTokenError: Raises [MismatchedTokenError][tembo.exceptions.MismatchedTokenError] if the number of input tokens does not match the number of unique input tokens defined. exceptions.BasePathDoesNotExistError: Raises [BasePathDoesNotExistError][tembo.exceptions.BasePathDoesNotExistError] if the base path does not exist. exceptions.TemplateFileNotFoundError: Raises [TemplateFileNotFoundError][tembo.exceptions.TemplateFileNotFoundError] if the template file is specified but not found. Returns: Page: A [ScopedPage][tembo.journal.pages.ScopedPage] object using the `PageCreatorOptions`. \"\"\" try : self . _check_base_path_exists () except exceptions . BasePathDoesNotExistError as base_path_does_not_exist_error : raise base_path_does_not_exist_error self . _all_input_tokens = self . _get_input_tokens () try : self . _verify_input_tokens () except exceptions . MismatchedTokenError as mismatched_token_error : raise mismatched_token_error path = self . _convert_base_path_to_path () path = pathlib . Path ( self . _substitute_tokens ( str ( path ))) try : template_contents = self . _load_template () except exceptions . TemplateFileNotFoundError as template_not_found_error : raise template_not_found_error if self . options . template_filename is not None : template_contents = self . _substitute_tokens ( template_contents ) return ScopedPage ( path , template_contents )","title":"pages.py"},{"location":"code_reference/journal/pages/#tembo.journal.pages.Page","text":"Abstract Page class. This interface is used to define a Page object. A Page represents a note/page that will be saved to disk. Abstract This object is an abstract base class and should be implemented for each Page type.","title":"Page"},{"location":"code_reference/journal/pages/#tembo.journal.pages.Page.path","text":"When implemented this should return the full path of the page including the filename. Returns: Type Description pathlib.Path the path as a Path object. Abstract This property is abstract and should be implemented for each Page type.","title":"path"},{"location":"code_reference/journal/pages/#tembo.journal.pages.Page.__init__","text":"When implemented this should initalise a Page object. Parameters: Name Type Description Default path pathlib.Path the full path of the page including the filename as a Path . required page_content str the contents of the page. required Abstract This method is abstract and should be implemented for each Page type. Source code in tembo/journal/pages.py @abstractmethod def __init__ ( self , path : pathlib . Path , page_content : str ) -> None : \"\"\" When implemented this should initalise a Page object. Args: path (pathlib.Path): the full path of the page including the filename as a [Path][pathlib.Path]. page_content (str): the contents of the page. !!! abstract This method is abstract and should be implemented for each `Page` type. \"\"\" raise NotImplementedError","title":"__init__()"},{"location":"code_reference/journal/pages/#tembo.journal.pages.Page.save_to_disk","text":"When implemented this should save the page to disk. Returns: Type Description tembo.utils.Success A Tembo Success object. Abstract This method is abstract and should be implemented for each Page type. Source code in tembo/journal/pages.py @abstractmethod def save_to_disk ( self ) -> tembo . utils . Success : \"\"\" When implemented this should save the page to disk. Returns: tembo.utils.Success: A Tembo [Success][tembo.utils.__init__.Success] object. !!! abstract This method is abstract and should be implemented for each `Page` type. \"\"\" raise NotImplementedError","title":"save_to_disk()"},{"location":"code_reference/journal/pages/#tembo.journal.pages.PageCreator","text":"A PageCreator factory base class. This factory should implement methods to create Page objects. Abstract This factory is an abstract base class and should be implemented for each Page type. The private methods _check_base_path_exists() _convert_base_path_to_path() _load_template() are not abstract and are shared between all Page types.","title":"PageCreator"},{"location":"code_reference/journal/pages/#tembo.journal.pages.PageCreator.options","text":"When implemented this should return the PageCreatorOptions on the class. Returns: Type Description PageCreatorOptions the instance of PageCreatorOptions set on the class. Abstract This method is abstract and should be implemented for each Page type.","title":"options"},{"location":"code_reference/journal/pages/#tembo.journal.pages.PageCreator.__init__","text":"When implemented this should initialise the PageCreator factory. Parameters: Name Type Description Default options PageCreatorOptions An instance of PageCreatorOptions required Abstract This method is abstract and should be implemented for each Page type. Source code in tembo/journal/pages.py @abstractmethod def __init__ ( self , options : PageCreatorOptions ) -> None : \"\"\" When implemented this should initialise the `PageCreator` factory. Args: options (PageCreatorOptions): An instance of [PageCreatorOptions][tembo.journal.pages.PageCreatorOptions] !!! abstract This method is abstract and should be implemented for each [Page][tembo.journal.pages.Page] type. \"\"\" raise NotImplementedError","title":"__init__()"},{"location":"code_reference/journal/pages/#tembo.journal.pages.PageCreator.create_page","text":"When implemented this should create a Page object. Returns: Type Description Page an implemented instance of Page such as ScopedPage . Abstract This method is abstract and should be implemented for each Page type. Source code in tembo/journal/pages.py @abstractmethod def create_page ( self ) -> Page : \"\"\" When implemented this should create a `Page` object. Returns: Page: an implemented instance of [Page][tembo.journal.pages.Page] such as [ScopedPage][tembo.journal.pages.ScopedPage]. !!! abstract This method is abstract and should be implemented for each [Page][tembo.journal.pages.Page] type. \"\"\" raise NotImplementedError","title":"create_page()"},{"location":"code_reference/journal/pages/#tembo.journal.pages.PageCreatorOptions","text":"Options dataclass to create a Page. This is passed to an implemented instance of PageCreator Attributes: Name Type Description base_path str The base path. page_path str The path of the page relative to the base path. filename str The filename of the page. extension str The extension of the page. name str The name of the scope. user_input Collection[str] | None User input tokens. example str | None User example command. template_path str | None The path which contains the templates. This should be the full path and not relative to the base path. template_filename str | None The template filename with extension relative to the template path.","title":"PageCreatorOptions"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPage","text":"A page that uses substitute tokens. Attributes: Name Type Description path pathlib.Path a Path object of the page's filepath including the filename. page_content str the content of the page from the template.","title":"ScopedPage"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPage.path","text":"Return the full path of the page. Returns: Type Description pathlib.path The full path of the page as a Path object.","title":"path"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPage.__init__","text":"Initalise a scoped page object. Parameters: Name Type Description Default path pathlib.Path a Path object of the page's filepath including the filename. required page_content str the content of the page from the template. required Source code in tembo/journal/pages.py def __init__ ( self , path : pathlib . Path , page_content : str ) -> None : \"\"\" Initalise a scoped page object. Args: path (pathlib.Path): a [Path][pathlib.Path] object of the page's filepath including the filename. page_content (str): the content of the page from the template. \"\"\" self . _path = path self . page_content = page_content","title":"__init__()"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPage.__str__","text":"Return a str representation of a ScopedPage . Examples: >>> str(ScopedPage(Path(\"/home/bob/tembo/meetings/my_meeting_0.md\"), \"\")) ScopedPage(\"/home/bob/tembo/meetings/my_meeting_0.md\") Returns: Type Description str The ScopedPage as a str . Source code in tembo/journal/pages.py def __str__ ( self ) -> str : \"\"\" Return a `str` representation of a `ScopedPage`. Examples: ``` >>> str(ScopedPage(Path(\"/home/bob/tembo/meetings/my_meeting_0.md\"), \"\")) ScopedPage(\"/home/bob/tembo/meetings/my_meeting_0.md\") ``` Returns: str: The `ScopedPage` as a `str`. \"\"\" return f 'ScopedPage(\" { self . path } \")'","title":"__str__()"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPage.save_to_disk","text":"Save the scoped page to disk and write the page_content . Exceptions: Type Description exceptions.ScopedPageAlreadyExists If the page already exists a ScopedPageAlreadyExists exception is raised. Returns: Type Description tembo.utils.Success A Success with the path of the ScopedPage as the message. Source code in tembo/journal/pages.py def save_to_disk ( self ) -> tembo . utils . Success : \"\"\" Save the scoped page to disk and write the `page_content`. Raises: exceptions.ScopedPageAlreadyExists: If the page already exists a [ScopedPageAlreadyExists][tembo.exceptions.ScopedPageAlreadyExists] exception is raised. Returns: tembo.utils.Success: A [Success][tembo.utils.__init__.Success] with the path of the ScopedPage as the message. \"\"\" # create the parent directories scoped_page_file = pathlib . Path ( self . path ) scoped_page_file . parents [ 0 ] . mkdir ( parents = True , exist_ok = True ) if scoped_page_file . exists (): raise exceptions . ScopedPageAlreadyExists ( f \" { self . path } already exists\" ) with scoped_page_file . open ( \"w\" , encoding = \"utf-8\" ) as scoped_page : scoped_page . write ( self . page_content ) return tembo . utils . Success ( str ( self . path ))","title":"save_to_disk()"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPageCreator","text":"Factory to create a scoped page. Attributes: Name Type Description base_path str base path of tembo. page_path str path of the page relative to the base path. filename str filename relative to the page path. extension str extension of file.","title":"ScopedPageCreator"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPageCreator.options","text":"Return the PageCreatorOptions instance set on the factory. Returns: Type Description PageCreatorOptions An instance of PageCreatorOptions .","title":"options"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPageCreator.__init__","text":"Initialise a ScopedPageCreator factory. Parameters: Name Type Description Default options PageCreatorOptions An instance of PageCreatorOptions . required Source code in tembo/journal/pages.py def __init__ ( self , options : PageCreatorOptions ) -> None : \"\"\" Initialise a `ScopedPageCreator` factory. Args: options (PageCreatorOptions): An instance of [PageCreatorOptions][tembo.journal.pages.PageCreatorOptions]. \"\"\" self . _all_input_tokens : list [ str ] = [] self . _options = options","title":"__init__()"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPageCreator.create_page","text":"Create a ScopedPage object. This method will Check the base_path exists Verify the input tokens match the number defined in the config.yml Substitue the input tokens in the filepath Load the template contents and substitue the input tokens Exceptions: Type Description exceptions.MismatchedTokenError Raises MismatchedTokenError if the number of input tokens does not match the number of unique input tokens defined. exceptions.BasePathDoesNotExistError Raises BasePathDoesNotExistError if the base path does not exist. exceptions.TemplateFileNotFoundError Raises TemplateFileNotFoundError if the template file is specified but not found. Returns: Type Description Page A ScopedPage object using the PageCreatorOptions . Source code in tembo/journal/pages.py def create_page ( self ) -> Page : \"\"\" Create a [ScopedPage][tembo.journal.pages.ScopedPage] object. This method will - Check the `base_path` exists - Verify the input tokens match the number defined in the `config.yml` - Substitue the input tokens in the filepath - Load the template contents and substitue the input tokens Raises: exceptions.MismatchedTokenError: Raises [MismatchedTokenError][tembo.exceptions.MismatchedTokenError] if the number of input tokens does not match the number of unique input tokens defined. exceptions.BasePathDoesNotExistError: Raises [BasePathDoesNotExistError][tembo.exceptions.BasePathDoesNotExistError] if the base path does not exist. exceptions.TemplateFileNotFoundError: Raises [TemplateFileNotFoundError][tembo.exceptions.TemplateFileNotFoundError] if the template file is specified but not found. Returns: Page: A [ScopedPage][tembo.journal.pages.ScopedPage] object using the `PageCreatorOptions`. \"\"\" try : self . _check_base_path_exists () except exceptions . BasePathDoesNotExistError as base_path_does_not_exist_error : raise base_path_does_not_exist_error self . _all_input_tokens = self . _get_input_tokens () try : self . _verify_input_tokens () except exceptions . MismatchedTokenError as mismatched_token_error : raise mismatched_token_error path = self . _convert_base_path_to_path () path = pathlib . Path ( self . _substitute_tokens ( str ( path ))) try : template_contents = self . _load_template () except exceptions . TemplateFileNotFoundError as template_not_found_error : raise template_not_found_error if self . options . template_filename is not None : template_contents = self . _substitute_tokens ( template_contents ) return ScopedPage ( path , template_contents )","title":"create_page()"},{"location":"code_reference/utils/__init__/","text":"Subpackage containing utility objects. Success dataclass \u00a4 A Tembo success object. This is returned from Page methods such as save_to_disk() Attributes: Name Type Description message str A success message.","title":"__init__.py"},{"location":"code_reference/utils/__init__/#tembo.utils.__init__.Success","text":"A Tembo success object. This is returned from Page methods such as save_to_disk() Attributes: Name Type Description message str A success message.","title":"Success"},{"location":"home/changelog/","text":"Changelog \u00a4 All notable changes to this project will be documented in this file. v1.0.2 - 2021-11-23 \u00a4 Compare with v1.0.1 Features \u00a4 Add garbage ( b49d77 ) Miscellaneous Tasks \u00a4 Prepare release v1.0.2 ( e29ae6 ) Update cliff.toml ( 7ee36f ) Update duties.py with latest changelog duty ( f6f2fe ) v1.0.1 - 2021-11-21 \u00a4 Compare with v1.0.0 Documentation \u00a4 Update changelog ( b71033 ) v1.0.0 - 2021-11-21 \u00a4 Documentation \u00a4 Update changelog ( 26fe81 ) Features \u00a4 Initial commit ( fb7fec ) Build \u00a4 Update panaetius to 2.3.3 ( e5d2b2 )","title":"Changelog"},{"location":"home/changelog/#changelog","text":"All notable changes to this project will be documented in this file.","title":"Changelog"},{"location":"home/changelog/#v102-2021-11-23","text":"Compare with v1.0.1","title":"v1.0.2 - 2021-11-23"},{"location":"home/changelog/#features","text":"Add garbage ( b49d77 )","title":"Features"},{"location":"home/changelog/#miscellaneous-tasks","text":"Prepare release v1.0.2 ( e29ae6 ) Update cliff.toml ( 7ee36f ) Update duties.py with latest changelog duty ( f6f2fe )","title":"Miscellaneous Tasks"},{"location":"home/changelog/#v101-2021-11-21","text":"Compare with v1.0.0","title":"v1.0.1 - 2021-11-21"},{"location":"home/changelog/#documentation","text":"Update changelog ( b71033 )","title":"Documentation"},{"location":"home/changelog/#v100-2021-11-21","text":"","title":"v1.0.0 - 2021-11-21"},{"location":"home/changelog/#documentation_1","text":"Update changelog ( 26fe81 )","title":"Documentation"},{"location":"home/changelog/#features_1","text":"Initial commit ( fb7fec )","title":"Features"},{"location":"home/changelog/#build","text":"Update panaetius to 2.3.3 ( e5d2b2 )","title":"Build"},{"location":"home/license/","text":"","title":"License"},{"location":"coverage/","text":".md-content { max-width: none !important; } article h1, article > a { display: none; } var coviframe = document.getElementById(\"coviframe\"); function resizeIframe() { coviframe.style.height = coviframe.contentWindow.document.documentElement.offsetHeight + 'px'; } coviframe.contentWindow.document.body.onclick = function() { coviframe.contentWindow.location.reload(); }","title":"Coverage report"}]}
\ No newline at end of file
+{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Tembo \u00a4 from tembo import Success v0.0.8","title":"Overview"},{"location":"#tembo","text":"from tembo import Success v0.0.8","title":"Tembo"},{"location":"cli_reference/main/","text":"CLI Reference \u00a4 tembo \u00a4 Tembo - an organiser for work notes. Usage: tembo <options> COMMAND [ARGS]... Options: Name Type Description Default -v , --version boolean Show the version and exit. False --help boolean Show this message and exit. False list \u00a4 List all scopes defined in the config.yml. Usage: tembo list <options> Options: Name Type Description Default --help boolean Show this message and exit. False new \u00a4 Create a new page. <scope> The name of the scope in the config.yml. <inputs> Any input token values that are defined in the config.yml for this scope. Accepts multiple inputs separated by a space. Example: tembo new meeting my_presentation Usage: tembo new <options> <scope> <inputs> Options: Name Type Description Default --dry-run boolean Show the full path of the page to be created without actually saving the page to disk and exit. False --example boolean Show the example command in the config.yml if it exists and exit. False --help boolean Show this message and exit. False","title":"tembo"},{"location":"cli_reference/main/#cli-reference","text":"","title":"CLI Reference"},{"location":"cli_reference/main/#tembo","text":"Tembo - an organiser for work notes. Usage: tembo <options> COMMAND [ARGS]... Options: Name Type Description Default -v , --version boolean Show the version and exit. False --help boolean Show this message and exit. False","title":"tembo"},{"location":"cli_reference/main/#list","text":"List all scopes defined in the config.yml. Usage: tembo list <options> Options: Name Type Description Default --help boolean Show this message and exit. False","title":"list"},{"location":"cli_reference/main/#new","text":"Create a new page. <scope> The name of the scope in the config.yml. <inputs> Any input token values that are defined in the config.yml for this scope. Accepts multiple inputs separated by a space. Example: tembo new meeting my_presentation Usage: tembo new <options> <scope> <inputs> Options: Name Type Description Default --dry-run boolean Show the full path of the page to be created without actually saving the page to disk and exit. False --example boolean Show the example command in the config.yml if it exists and exit. False --help boolean Show this message and exit. False","title":"new"},{"location":"code_reference/SUMMARY/","text":"__init__.py __main__.py _version.py cli __init__.py cli.py exceptions.py journal __init__.py pages.py utils __init__.py","title":"SUMMARY"},{"location":"code_reference/__init__/","text":"Tembo package. A simple folder organiser for your work notes.","title":"__init__.py"},{"location":"code_reference/__main__/","text":"Entrypoint module. Used when using python -m tembo to invoke the CLI.","title":"__main__.py"},{"location":"code_reference/_version/","text":"Module containing the version of tembo.","title":"_version.py"},{"location":"code_reference/exceptions/","text":"Module containing custom exceptions. BasePathDoesNotExistError ( Exception ) \u00a4 Raised if the base path does not exist. EmptyConfigYML ( Exception ) \u00a4 Raised if the config.yml file is empty. MandatoryKeyNotFound ( Exception ) \u00a4 Raised if a mandatory key is not found in the config.yml. MismatchedTokenError ( Exception ) \u00a4 Raised when the number of input tokens does not match the user config. Attributes: Name Type Description expected int number of input tokens in the user config. given int number of input tokens passed in. __init__ ( self , expected , given ) special \u00a4 Initialise the exception. Parameters: Name Type Description Default expected int number of input tokens in the user config. required given int number of input tokens passed in. required Source code in tembo/exceptions.py def __init__ ( self , expected : int , given : int ) -> None : \"\"\" Initialise the exception. Args: expected (int): number of input tokens in the user config. given (int): number of input tokens passed in. \"\"\" self . expected = expected self . given = given super () . __init__ () MissingConfigYML ( Exception ) \u00a4 Raised if the config.yml file is missing. ScopeNotFound ( Exception ) \u00a4 Raised if the scope does not exist in the config.yml. ScopedPageAlreadyExists ( Exception ) \u00a4 Raised if the scoped page file already exists. TemplateFileNotFoundError ( Exception ) \u00a4 Raised if the template file does not exist.","title":"exceptions.py"},{"location":"code_reference/exceptions/#tembo.exceptions.BasePathDoesNotExistError","text":"Raised if the base path does not exist.","title":"BasePathDoesNotExistError"},{"location":"code_reference/exceptions/#tembo.exceptions.EmptyConfigYML","text":"Raised if the config.yml file is empty.","title":"EmptyConfigYML"},{"location":"code_reference/exceptions/#tembo.exceptions.MandatoryKeyNotFound","text":"Raised if a mandatory key is not found in the config.yml.","title":"MandatoryKeyNotFound"},{"location":"code_reference/exceptions/#tembo.exceptions.MismatchedTokenError","text":"Raised when the number of input tokens does not match the user config. Attributes: Name Type Description expected int number of input tokens in the user config. given int number of input tokens passed in.","title":"MismatchedTokenError"},{"location":"code_reference/exceptions/#tembo.exceptions.MismatchedTokenError.__init__","text":"Initialise the exception. Parameters: Name Type Description Default expected int number of input tokens in the user config. required given int number of input tokens passed in. required Source code in tembo/exceptions.py def __init__ ( self , expected : int , given : int ) -> None : \"\"\" Initialise the exception. Args: expected (int): number of input tokens in the user config. given (int): number of input tokens passed in. \"\"\" self . expected = expected self . given = given super () . __init__ ()","title":"__init__()"},{"location":"code_reference/exceptions/#tembo.exceptions.MissingConfigYML","text":"Raised if the config.yml file is missing.","title":"MissingConfigYML"},{"location":"code_reference/exceptions/#tembo.exceptions.ScopeNotFound","text":"Raised if the scope does not exist in the config.yml.","title":"ScopeNotFound"},{"location":"code_reference/exceptions/#tembo.exceptions.ScopedPageAlreadyExists","text":"Raised if the scoped page file already exists.","title":"ScopedPageAlreadyExists"},{"location":"code_reference/exceptions/#tembo.exceptions.TemplateFileNotFoundError","text":"Raised if the template file does not exist.","title":"TemplateFileNotFoundError"},{"location":"code_reference/cli/__init__/","text":"Subpackage that contains the CLI application.","title":"__init__.py"},{"location":"code_reference/cli/cli/","text":"Submodule which contains the CLI implementation using Click. cli_message ( message ) \u00a4 Relay a message to the user using the CLI. Parameters: Name Type Description Default message str THe message to be displayed. required Source code in tembo/cli/cli.py def cli_message ( message : str ) -> None : \"\"\" Relay a message to the user using the CLI. Args: message (str): THe message to be displayed. \"\"\" click . echo ( f \"[TEMBO] { message } \ud83d\udc18\" )","title":"cli.py"},{"location":"code_reference/cli/cli/#tembo.cli.cli.cli_message","text":"Relay a message to the user using the CLI. Parameters: Name Type Description Default message str THe message to be displayed. required Source code in tembo/cli/cli.py def cli_message ( message : str ) -> None : \"\"\" Relay a message to the user using the CLI. Args: message (str): THe message to be displayed. \"\"\" click . echo ( f \"[TEMBO] { message } \ud83d\udc18\" )","title":"cli_message()"},{"location":"code_reference/journal/__init__/","text":"Subpackage containing the logic to create Tembo journals & pages.","title":"__init__.py"},{"location":"code_reference/journal/pages/","text":"Submodule containing the factories & page objects to create Tembo pages. Page \u00a4 Abstract Page class. This interface is used to define a Page object. A Page represents a note/page that will be saved to disk. Abstract This object is an abstract base class and should be implemented for each Page type. path : pathlib . Path property readonly \u00a4 When implemented this should return the full path of the page including the filename. Returns: Type Description pathlib.Path the path as a Path object. Abstract This property is abstract and should be implemented for each Page type. __init__ ( self , path , page_content ) special \u00a4 When implemented this should initalise a Page object. Parameters: Name Type Description Default path pathlib.Path the full path of the page including the filename as a Path . required page_content str the contents of the page. required Abstract This method is abstract and should be implemented for each Page type. Source code in tembo/journal/pages.py @abstractmethod def __init__ ( self , path : pathlib . Path , page_content : str ) -> None : \"\"\" When implemented this should initalise a Page object. Args: path (pathlib.Path): the full path of the page including the filename as a [Path][pathlib.Path]. page_content (str): the contents of the page. !!! abstract This method is abstract and should be implemented for each `Page` type. \"\"\" raise NotImplementedError save_to_disk ( self ) \u00a4 When implemented this should save the page to disk. Returns: Type Description tembo.utils.Success A Tembo Success object. Abstract This method is abstract and should be implemented for each Page type. Source code in tembo/journal/pages.py @abstractmethod def save_to_disk ( self ) -> tembo . utils . Success : \"\"\" When implemented this should save the page to disk. Returns: tembo.utils.Success: A Tembo [Success][tembo.utils.__init__.Success] object. !!! abstract This method is abstract and should be implemented for each `Page` type. \"\"\" raise NotImplementedError PageCreator \u00a4 A PageCreator factory base class. This factory should implement methods to create Page objects. Abstract This factory is an abstract base class and should be implemented for each Page type. The private methods _check_base_path_exists() _convert_base_path_to_path() _load_template() are not abstract and are shared between all Page types. options : PageCreatorOptions property readonly \u00a4 When implemented this should return the PageCreatorOptions on the class. Returns: Type Description PageCreatorOptions the instance of PageCreatorOptions set on the class. Abstract This method is abstract and should be implemented for each Page type. __init__ ( self , options ) special \u00a4 When implemented this should initialise the PageCreator factory. Parameters: Name Type Description Default options PageCreatorOptions An instance of PageCreatorOptions required Abstract This method is abstract and should be implemented for each Page type. Source code in tembo/journal/pages.py @abstractmethod def __init__ ( self , options : PageCreatorOptions ) -> None : \"\"\" When implemented this should initialise the `PageCreator` factory. Args: options (PageCreatorOptions): An instance of [PageCreatorOptions][tembo.journal.pages.PageCreatorOptions] !!! abstract This method is abstract and should be implemented for each [Page][tembo.journal.pages.Page] type. \"\"\" raise NotImplementedError create_page ( self ) \u00a4 When implemented this should create a Page object. Returns: Type Description Page an implemented instance of Page such as ScopedPage . Abstract This method is abstract and should be implemented for each Page type. Source code in tembo/journal/pages.py @abstractmethod def create_page ( self ) -> Page : \"\"\" When implemented this should create a `Page` object. Returns: Page: an implemented instance of [Page][tembo.journal.pages.Page] such as [ScopedPage][tembo.journal.pages.ScopedPage]. !!! abstract This method is abstract and should be implemented for each [Page][tembo.journal.pages.Page] type. \"\"\" raise NotImplementedError PageCreatorOptions dataclass \u00a4 Options dataclass to create a Page. This is passed to an implemented instance of PageCreator Attributes: Name Type Description base_path str The base path. page_path str The path of the page relative to the base path. filename str The filename of the page. extension str The extension of the page. name str The name of the scope. user_input Collection[str] | None User input tokens. example str | None User example command. template_path str | None The path which contains the templates. This should be the full path and not relative to the base path. template_filename str | None The template filename with extension relative to the template path. ScopedPage ( Page ) \u00a4 A page that uses substitute tokens. Attributes: Name Type Description path pathlib.Path a Path object of the page's filepath including the filename. page_content str the content of the page from the template. path : pathlib . Path property readonly \u00a4 Return the full path of the page. Returns: Type Description pathlib.path The full path of the page as a Path object. __init__ ( self , path , page_content ) special \u00a4 Initalise a scoped page object. Parameters: Name Type Description Default path pathlib.Path a Path object of the page's filepath including the filename. required page_content str the content of the page from the template. required Source code in tembo/journal/pages.py def __init__ ( self , path : pathlib . Path , page_content : str ) -> None : \"\"\" Initalise a scoped page object. Args: path (pathlib.Path): a [Path][pathlib.Path] object of the page's filepath including the filename. page_content (str): the content of the page from the template. \"\"\" self . _path = path self . page_content = page_content __str__ ( self ) special \u00a4 Return a str representation of a ScopedPage . Examples: >>> str(ScopedPage(Path(\"/home/bob/tembo/meetings/my_meeting_0.md\"), \"\")) ScopedPage(\"/home/bob/tembo/meetings/my_meeting_0.md\") Returns: Type Description str The ScopedPage as a str . Source code in tembo/journal/pages.py def __str__ ( self ) -> str : \"\"\" Return a `str` representation of a `ScopedPage`. Examples: ``` >>> str(ScopedPage(Path(\"/home/bob/tembo/meetings/my_meeting_0.md\"), \"\")) ScopedPage(\"/home/bob/tembo/meetings/my_meeting_0.md\") ``` Returns: str: The `ScopedPage` as a `str`. \"\"\" return f 'ScopedPage(\" { self . path } \")' save_to_disk ( self ) \u00a4 Save the scoped page to disk and write the page_content . Exceptions: Type Description exceptions.ScopedPageAlreadyExists If the page already exists a ScopedPageAlreadyExists exception is raised. Returns: Type Description tembo.utils.Success A Success with the path of the ScopedPage as the message. Source code in tembo/journal/pages.py def save_to_disk ( self ) -> tembo . utils . Success : \"\"\" Save the scoped page to disk and write the `page_content`. Raises: exceptions.ScopedPageAlreadyExists: If the page already exists a [ScopedPageAlreadyExists][tembo.exceptions.ScopedPageAlreadyExists] exception is raised. Returns: tembo.utils.Success: A [Success][tembo.utils.__init__.Success] with the path of the ScopedPage as the message. \"\"\" # create the parent directories scoped_page_file = pathlib . Path ( self . path ) scoped_page_file . parents [ 0 ] . mkdir ( parents = True , exist_ok = True ) if scoped_page_file . exists (): raise exceptions . ScopedPageAlreadyExists ( f \" { self . path } already exists\" ) with scoped_page_file . open ( \"w\" , encoding = \"utf-8\" ) as scoped_page : scoped_page . write ( self . page_content ) return tembo . utils . Success ( str ( self . path )) ScopedPageCreator ( PageCreator ) \u00a4 Factory to create a scoped page. Attributes: Name Type Description base_path str base path of tembo. page_path str path of the page relative to the base path. filename str filename relative to the page path. extension str extension of file. options : PageCreatorOptions property readonly \u00a4 Return the PageCreatorOptions instance set on the factory. Returns: Type Description PageCreatorOptions An instance of PageCreatorOptions . __init__ ( self , options ) special \u00a4 Initialise a ScopedPageCreator factory. Parameters: Name Type Description Default options PageCreatorOptions An instance of PageCreatorOptions . required Source code in tembo/journal/pages.py def __init__ ( self , options : PageCreatorOptions ) -> None : \"\"\" Initialise a `ScopedPageCreator` factory. Args: options (PageCreatorOptions): An instance of [PageCreatorOptions][tembo.journal.pages.PageCreatorOptions]. \"\"\" self . _all_input_tokens : list [ str ] = [] self . _options = options create_page ( self ) \u00a4 Create a ScopedPage object. This method will Check the base_path exists Verify the input tokens match the number defined in the config.yml Substitue the input tokens in the filepath Load the template contents and substitue the input tokens Exceptions: Type Description exceptions.MismatchedTokenError Raises MismatchedTokenError if the number of input tokens does not match the number of unique input tokens defined. exceptions.BasePathDoesNotExistError Raises BasePathDoesNotExistError if the base path does not exist. exceptions.TemplateFileNotFoundError Raises TemplateFileNotFoundError if the template file is specified but not found. Returns: Type Description Page A ScopedPage object using the PageCreatorOptions . Source code in tembo/journal/pages.py def create_page ( self ) -> Page : \"\"\" Create a [ScopedPage][tembo.journal.pages.ScopedPage] object. This method will - Check the `base_path` exists - Verify the input tokens match the number defined in the `config.yml` - Substitue the input tokens in the filepath - Load the template contents and substitue the input tokens Raises: exceptions.MismatchedTokenError: Raises [MismatchedTokenError][tembo.exceptions.MismatchedTokenError] if the number of input tokens does not match the number of unique input tokens defined. exceptions.BasePathDoesNotExistError: Raises [BasePathDoesNotExistError][tembo.exceptions.BasePathDoesNotExistError] if the base path does not exist. exceptions.TemplateFileNotFoundError: Raises [TemplateFileNotFoundError][tembo.exceptions.TemplateFileNotFoundError] if the template file is specified but not found. Returns: Page: A [ScopedPage][tembo.journal.pages.ScopedPage] object using the `PageCreatorOptions`. \"\"\" try : self . _check_base_path_exists () except exceptions . BasePathDoesNotExistError as base_path_does_not_exist_error : raise base_path_does_not_exist_error self . _all_input_tokens = self . _get_input_tokens () try : self . _verify_input_tokens () except exceptions . MismatchedTokenError as mismatched_token_error : raise mismatched_token_error path = self . _convert_base_path_to_path () path = pathlib . Path ( self . _substitute_tokens ( str ( path ))) try : template_contents = self . _load_template () except exceptions . TemplateFileNotFoundError as template_not_found_error : raise template_not_found_error if self . options . template_filename is not None : template_contents = self . _substitute_tokens ( template_contents ) return ScopedPage ( path , template_contents )","title":"pages.py"},{"location":"code_reference/journal/pages/#tembo.journal.pages.Page","text":"Abstract Page class. This interface is used to define a Page object. A Page represents a note/page that will be saved to disk. Abstract This object is an abstract base class and should be implemented for each Page type.","title":"Page"},{"location":"code_reference/journal/pages/#tembo.journal.pages.Page.path","text":"When implemented this should return the full path of the page including the filename. Returns: Type Description pathlib.Path the path as a Path object. Abstract This property is abstract and should be implemented for each Page type.","title":"path"},{"location":"code_reference/journal/pages/#tembo.journal.pages.Page.__init__","text":"When implemented this should initalise a Page object. Parameters: Name Type Description Default path pathlib.Path the full path of the page including the filename as a Path . required page_content str the contents of the page. required Abstract This method is abstract and should be implemented for each Page type. Source code in tembo/journal/pages.py @abstractmethod def __init__ ( self , path : pathlib . Path , page_content : str ) -> None : \"\"\" When implemented this should initalise a Page object. Args: path (pathlib.Path): the full path of the page including the filename as a [Path][pathlib.Path]. page_content (str): the contents of the page. !!! abstract This method is abstract and should be implemented for each `Page` type. \"\"\" raise NotImplementedError","title":"__init__()"},{"location":"code_reference/journal/pages/#tembo.journal.pages.Page.save_to_disk","text":"When implemented this should save the page to disk. Returns: Type Description tembo.utils.Success A Tembo Success object. Abstract This method is abstract and should be implemented for each Page type. Source code in tembo/journal/pages.py @abstractmethod def save_to_disk ( self ) -> tembo . utils . Success : \"\"\" When implemented this should save the page to disk. Returns: tembo.utils.Success: A Tembo [Success][tembo.utils.__init__.Success] object. !!! abstract This method is abstract and should be implemented for each `Page` type. \"\"\" raise NotImplementedError","title":"save_to_disk()"},{"location":"code_reference/journal/pages/#tembo.journal.pages.PageCreator","text":"A PageCreator factory base class. This factory should implement methods to create Page objects. Abstract This factory is an abstract base class and should be implemented for each Page type. The private methods _check_base_path_exists() _convert_base_path_to_path() _load_template() are not abstract and are shared between all Page types.","title":"PageCreator"},{"location":"code_reference/journal/pages/#tembo.journal.pages.PageCreator.options","text":"When implemented this should return the PageCreatorOptions on the class. Returns: Type Description PageCreatorOptions the instance of PageCreatorOptions set on the class. Abstract This method is abstract and should be implemented for each Page type.","title":"options"},{"location":"code_reference/journal/pages/#tembo.journal.pages.PageCreator.__init__","text":"When implemented this should initialise the PageCreator factory. Parameters: Name Type Description Default options PageCreatorOptions An instance of PageCreatorOptions required Abstract This method is abstract and should be implemented for each Page type. Source code in tembo/journal/pages.py @abstractmethod def __init__ ( self , options : PageCreatorOptions ) -> None : \"\"\" When implemented this should initialise the `PageCreator` factory. Args: options (PageCreatorOptions): An instance of [PageCreatorOptions][tembo.journal.pages.PageCreatorOptions] !!! abstract This method is abstract and should be implemented for each [Page][tembo.journal.pages.Page] type. \"\"\" raise NotImplementedError","title":"__init__()"},{"location":"code_reference/journal/pages/#tembo.journal.pages.PageCreator.create_page","text":"When implemented this should create a Page object. Returns: Type Description Page an implemented instance of Page such as ScopedPage . Abstract This method is abstract and should be implemented for each Page type. Source code in tembo/journal/pages.py @abstractmethod def create_page ( self ) -> Page : \"\"\" When implemented this should create a `Page` object. Returns: Page: an implemented instance of [Page][tembo.journal.pages.Page] such as [ScopedPage][tembo.journal.pages.ScopedPage]. !!! abstract This method is abstract and should be implemented for each [Page][tembo.journal.pages.Page] type. \"\"\" raise NotImplementedError","title":"create_page()"},{"location":"code_reference/journal/pages/#tembo.journal.pages.PageCreatorOptions","text":"Options dataclass to create a Page. This is passed to an implemented instance of PageCreator Attributes: Name Type Description base_path str The base path. page_path str The path of the page relative to the base path. filename str The filename of the page. extension str The extension of the page. name str The name of the scope. user_input Collection[str] | None User input tokens. example str | None User example command. template_path str | None The path which contains the templates. This should be the full path and not relative to the base path. template_filename str | None The template filename with extension relative to the template path.","title":"PageCreatorOptions"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPage","text":"A page that uses substitute tokens. Attributes: Name Type Description path pathlib.Path a Path object of the page's filepath including the filename. page_content str the content of the page from the template.","title":"ScopedPage"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPage.path","text":"Return the full path of the page. Returns: Type Description pathlib.path The full path of the page as a Path object.","title":"path"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPage.__init__","text":"Initalise a scoped page object. Parameters: Name Type Description Default path pathlib.Path a Path object of the page's filepath including the filename. required page_content str the content of the page from the template. required Source code in tembo/journal/pages.py def __init__ ( self , path : pathlib . Path , page_content : str ) -> None : \"\"\" Initalise a scoped page object. Args: path (pathlib.Path): a [Path][pathlib.Path] object of the page's filepath including the filename. page_content (str): the content of the page from the template. \"\"\" self . _path = path self . page_content = page_content","title":"__init__()"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPage.__str__","text":"Return a str representation of a ScopedPage . Examples: >>> str(ScopedPage(Path(\"/home/bob/tembo/meetings/my_meeting_0.md\"), \"\")) ScopedPage(\"/home/bob/tembo/meetings/my_meeting_0.md\") Returns: Type Description str The ScopedPage as a str . Source code in tembo/journal/pages.py def __str__ ( self ) -> str : \"\"\" Return a `str` representation of a `ScopedPage`. Examples: ``` >>> str(ScopedPage(Path(\"/home/bob/tembo/meetings/my_meeting_0.md\"), \"\")) ScopedPage(\"/home/bob/tembo/meetings/my_meeting_0.md\") ``` Returns: str: The `ScopedPage` as a `str`. \"\"\" return f 'ScopedPage(\" { self . path } \")'","title":"__str__()"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPage.save_to_disk","text":"Save the scoped page to disk and write the page_content . Exceptions: Type Description exceptions.ScopedPageAlreadyExists If the page already exists a ScopedPageAlreadyExists exception is raised. Returns: Type Description tembo.utils.Success A Success with the path of the ScopedPage as the message. Source code in tembo/journal/pages.py def save_to_disk ( self ) -> tembo . utils . Success : \"\"\" Save the scoped page to disk and write the `page_content`. Raises: exceptions.ScopedPageAlreadyExists: If the page already exists a [ScopedPageAlreadyExists][tembo.exceptions.ScopedPageAlreadyExists] exception is raised. Returns: tembo.utils.Success: A [Success][tembo.utils.__init__.Success] with the path of the ScopedPage as the message. \"\"\" # create the parent directories scoped_page_file = pathlib . Path ( self . path ) scoped_page_file . parents [ 0 ] . mkdir ( parents = True , exist_ok = True ) if scoped_page_file . exists (): raise exceptions . ScopedPageAlreadyExists ( f \" { self . path } already exists\" ) with scoped_page_file . open ( \"w\" , encoding = \"utf-8\" ) as scoped_page : scoped_page . write ( self . page_content ) return tembo . utils . Success ( str ( self . path ))","title":"save_to_disk()"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPageCreator","text":"Factory to create a scoped page. Attributes: Name Type Description base_path str base path of tembo. page_path str path of the page relative to the base path. filename str filename relative to the page path. extension str extension of file.","title":"ScopedPageCreator"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPageCreator.options","text":"Return the PageCreatorOptions instance set on the factory. Returns: Type Description PageCreatorOptions An instance of PageCreatorOptions .","title":"options"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPageCreator.__init__","text":"Initialise a ScopedPageCreator factory. Parameters: Name Type Description Default options PageCreatorOptions An instance of PageCreatorOptions . required Source code in tembo/journal/pages.py def __init__ ( self , options : PageCreatorOptions ) -> None : \"\"\" Initialise a `ScopedPageCreator` factory. Args: options (PageCreatorOptions): An instance of [PageCreatorOptions][tembo.journal.pages.PageCreatorOptions]. \"\"\" self . _all_input_tokens : list [ str ] = [] self . _options = options","title":"__init__()"},{"location":"code_reference/journal/pages/#tembo.journal.pages.ScopedPageCreator.create_page","text":"Create a ScopedPage object. This method will Check the base_path exists Verify the input tokens match the number defined in the config.yml Substitue the input tokens in the filepath Load the template contents and substitue the input tokens Exceptions: Type Description exceptions.MismatchedTokenError Raises MismatchedTokenError if the number of input tokens does not match the number of unique input tokens defined. exceptions.BasePathDoesNotExistError Raises BasePathDoesNotExistError if the base path does not exist. exceptions.TemplateFileNotFoundError Raises TemplateFileNotFoundError if the template file is specified but not found. Returns: Type Description Page A ScopedPage object using the PageCreatorOptions . Source code in tembo/journal/pages.py def create_page ( self ) -> Page : \"\"\" Create a [ScopedPage][tembo.journal.pages.ScopedPage] object. This method will - Check the `base_path` exists - Verify the input tokens match the number defined in the `config.yml` - Substitue the input tokens in the filepath - Load the template contents and substitue the input tokens Raises: exceptions.MismatchedTokenError: Raises [MismatchedTokenError][tembo.exceptions.MismatchedTokenError] if the number of input tokens does not match the number of unique input tokens defined. exceptions.BasePathDoesNotExistError: Raises [BasePathDoesNotExistError][tembo.exceptions.BasePathDoesNotExistError] if the base path does not exist. exceptions.TemplateFileNotFoundError: Raises [TemplateFileNotFoundError][tembo.exceptions.TemplateFileNotFoundError] if the template file is specified but not found. Returns: Page: A [ScopedPage][tembo.journal.pages.ScopedPage] object using the `PageCreatorOptions`. \"\"\" try : self . _check_base_path_exists () except exceptions . BasePathDoesNotExistError as base_path_does_not_exist_error : raise base_path_does_not_exist_error self . _all_input_tokens = self . _get_input_tokens () try : self . _verify_input_tokens () except exceptions . MismatchedTokenError as mismatched_token_error : raise mismatched_token_error path = self . _convert_base_path_to_path () path = pathlib . Path ( self . _substitute_tokens ( str ( path ))) try : template_contents = self . _load_template () except exceptions . TemplateFileNotFoundError as template_not_found_error : raise template_not_found_error if self . options . template_filename is not None : template_contents = self . _substitute_tokens ( template_contents ) return ScopedPage ( path , template_contents )","title":"create_page()"},{"location":"code_reference/utils/__init__/","text":"Subpackage containing utility objects. Success dataclass \u00a4 A Tembo success object. This is returned from Page methods such as save_to_disk() Attributes: Name Type Description message str A success message.","title":"__init__.py"},{"location":"code_reference/utils/__init__/#tembo.utils.__init__.Success","text":"A Tembo success object. This is returned from Page methods such as save_to_disk() Attributes: Name Type Description message str A success message.","title":"Success"},{"location":"home/changelog/","text":"Changelog \u00a4 All notable changes to this project will be documented in this file. The format is based on Keep a Changelog , and this project adheres to Semantic Versioning . 1.0.1 - 2021-11-21 \u00a4 Compare with v1.0.0 Miscellaneous Tasks \u00a4 Add changelog generation using git-cliff ( 4c8d68 ) Prepare release 1.0.1 ( b077aa ) 1.0.0 - 2021-11-21 \u00a4 Documentation \u00a4 Update changelog ( 26fe81 ) Features \u00a4 Initial commit ( fb7fec ) Miscellaneous Tasks \u00a4 Update duties.py ( 562de6 ) Prepare release 1.0.0 ( eed47d ) Build \u00a4 Update panaetius to 2.3.3 ( e5d2b2 )","title":"Changelog"},{"location":"home/changelog/#changelog","text":"All notable changes to this project will be documented in this file. The format is based on Keep a Changelog , and this project adheres to Semantic Versioning .","title":"Changelog"},{"location":"home/changelog/#101-2021-11-21","text":"Compare with v1.0.0","title":"1.0.1 - 2021-11-21"},{"location":"home/changelog/#miscellaneous-tasks","text":"Add changelog generation using git-cliff ( 4c8d68 ) Prepare release 1.0.1 ( b077aa )","title":"Miscellaneous Tasks"},{"location":"home/changelog/#100-2021-11-21","text":"","title":"1.0.0 - 2021-11-21"},{"location":"home/changelog/#documentation","text":"Update changelog ( 26fe81 )","title":"Documentation"},{"location":"home/changelog/#features","text":"Initial commit ( fb7fec )","title":"Features"},{"location":"home/changelog/#miscellaneous-tasks_1","text":"Update duties.py ( 562de6 ) Prepare release 1.0.0 ( eed47d )","title":"Miscellaneous Tasks"},{"location":"home/changelog/#build","text":"Update panaetius to 2.3.3 ( e5d2b2 )","title":"Build"},{"location":"home/license/","text":"","title":"License"},{"location":"coverage/","text":".md-content { max-width: none !important; } article h1, article > a { display: none; } var coviframe = document.getElementById(\"coviframe\"); function resizeIframe() { coviframe.style.height = coviframe.contentWindow.document.documentElement.offsetHeight + 'px'; } coviframe.contentWindow.document.body.onclick = function() { coviframe.contentWindow.location.reload(); }","title":"Coverage report"}]}
\ No newline at end of file
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
index e2c1b98434175262cf9ed15916bf6f8ef4833842..cf982be405f1f1458779cd72d882c28acb71ad39 100644
GIT binary patch
delta 14
VcmX@cbc~5rzMF&N=tfpYMgSp_1PuTH

delta 14
VcmX@cbc~5rzMF$%-bPkOMgSns1Lgn#