updated docs;

docs/_modules/happypanda/interface/tag.html

@@ -157,11 +157,11 @@
         <div class="col-md-9 content">
 
   <h1>Source code for happypanda.interface.tag</h1><div class="highlight"><pre>
-<span></span><span class="kn">from</span> <span class="nn">happypanda.common</span> <span class="k">import</span> <span class="n">constants</span><span class="p">,</span> <span class="n">utils</span><span class="p">,</span> <span class="n">exceptions</span>
-<span class="kn">from</span> <span class="nn">happypanda.core</span> <span class="k">import</span> <span class="n">db</span><span class="p">,</span> <span class="n">services</span><span class="p">,</span> <span class="n">message</span>
+<span></span><span class="kn">from</span> <span class="nn">happypanda.core</span> <span class="k">import</span> <span class="n">db</span><span class="p">,</span> <span class="n">message</span>
 <span class="kn">from</span> <span class="nn">happypanda.interface</span> <span class="k">import</span> <span class="n">enums</span>
 <span class="kn">from</span> <span class="nn">happypanda.core.commands</span> <span class="k">import</span> <span class="n">database_cmd</span>
 
+
 <div class="viewcode-block" id="get_tags"><a class="viewcode-back" href="../../../api.html#happypanda.interface.tag.get_tags">[docs]</a><span class="k">def</span> <span class="nf">get_tags</span><span class="p">(</span><span class="n">item_type</span><span class="p">:</span> <span class="n">enums</span><span class="o">.</span><span class="n">ItemType</span> <span class="o">=</span> <span class="n">enums</span><span class="o">.</span><span class="n">ItemType</span><span class="o">.</span><span class="n">Gallery</span><span class="p">,</span>
              <span class="n">item_id</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
              <span class="n">raw</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">):</span>
@@ -180,7 +180,7 @@ <h1>Source code for happypanda.interface.tag</h1><div class="highlight"><pre>
 <span class="sd">        { namespace : list of tag message objects }</span>
 <span class="sd">        ```</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    
+
     <span class="n">item_type</span> <span class="o">=</span> <span class="n">enums</span><span class="o">.</span><span class="n">ItemType</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">item_type</span><span class="p">)</span>
 
     <span class="n">_</span><span class="p">,</span> <span class="n">db_item</span> <span class="o">=</span> <span class="n">item_type</span><span class="o">.</span><span class="n">_msg_and_model</span><span class="p">(</span>
@@ -203,27 +203,23 @@ <h1>Source code for happypanda.interface.tag</h1><div class="highlight"><pre>
                 <span class="k">if</span> <span class="ow">not</span> <span class="n">raw</span><span class="p">:</span>
                     <span class="n">g_objs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">g</span><span class="p">)</span>
 
-        <span class="n">related_col</span> <span class="o">=</span> <span class="n">db</span><span class="o">.</span><span class="n">relationship_column</span><span class="p">(</span><span class="n">db</span><span class="o">.</span><span class="n">Gallery</span><span class="p">,</span> <span class="n">db_item</span><span class="p">)</span>
-        <span class="n">related</span> <span class="o">=</span> <span class="n">db</span><span class="o">.</span><span class="n">related_classes</span><span class="p">(</span><span class="n">db_item</span><span class="p">)</span>
-
         <span class="k">for</span> <span class="n">g_obj</span> <span class="ow">in</span> <span class="n">g_objs</span><span class="p">:</span>
-            <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">g_obj</span><span class="o">.</span><span class="n">pages</span><span class="o">.</span><span class="n">all</span><span class="p">():</span> <span class="c1"># TODO: we only need tags</span>
+            <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">g_obj</span><span class="o">.</span><span class="n">pages</span><span class="o">.</span><span class="n">all</span><span class="p">():</span>  <span class="c1"># TODO: we only need tags</span>
                 <span class="n">nstags</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">all</span><span class="p">())</span>
 
     <span class="n">msg</span> <span class="o">=</span> <span class="p">{}</span>
     <span class="n">_msg</span> <span class="o">=</span> <span class="p">{}</span>
     <span class="k">for</span> <span class="n">nstag</span> <span class="ow">in</span> <span class="n">nstags</span><span class="p">:</span>
         <span class="n">ns</span> <span class="o">=</span> <span class="n">nstag</span><span class="o">.</span><span class="n">namespace</span><span class="o">.</span><span class="n">name</span>
-        <span class="k">if</span> <span class="ow">not</span> <span class="n">ns</span> <span class="ow">in</span> <span class="n">msg</span><span class="p">:</span>
+        <span class="k">if</span> <span class="n">ns</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">msg</span><span class="p">:</span>
             <span class="n">msg</span><span class="p">[</span><span class="n">ns</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
             <span class="n">_msg</span><span class="p">[</span><span class="n">ns</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
 
-        <span class="k">if</span> <span class="ow">not</span> <span class="n">nstag</span><span class="o">.</span><span class="n">tag</span><span class="o">.</span><span class="n">name</span> <span class="ow">in</span> <span class="n">_msg</span><span class="p">[</span><span class="n">ns</span><span class="p">]:</span>
+        <span class="k">if</span> <span class="n">nstag</span><span class="o">.</span><span class="n">tag</span><span class="o">.</span><span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_msg</span><span class="p">[</span><span class="n">ns</span><span class="p">]:</span>
             <span class="n">msg</span><span class="p">[</span><span class="n">ns</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">Tag</span><span class="p">(</span><span class="n">nstag</span><span class="o">.</span><span class="n">tag</span><span class="p">,</span> <span class="n">nstag</span><span class="p">)</span><span class="o">.</span><span class="n">json_friendly</span><span class="p">(</span><span class="n">include_key</span><span class="o">=</span><span class="kc">False</span><span class="p">))</span>
             <span class="n">_msg</span><span class="p">[</span><span class="n">ns</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">nstag</span><span class="o">.</span><span class="n">tag</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
 
     <span class="k">return</span> <span class="n">message</span><span class="o">.</span><span class="n">Identity</span><span class="p">(</span><span class="s1">&#39;tags&#39;</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span></div>
-
 </pre></div>
 
         </div>

docs/_sources/api_general.rst.txt

@@ -1,9 +1,78 @@
-General
+General
 #######################################
 
 Database
 ----------------------------------------
 
+Hierarchy
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Collection** -> **Grouping** -> **Gallery** -> **Page**
+
+.. note::
+
+    **Grouping** is actually not a direct descendant of **Collection** as can be seen below,
+    but it is sometimes helpful to think of it as such.
+
+Recommended Usage
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Collection
+***************************************
+
+Conventions (e.g. ``C90``), magazines (e.g. ``Girls forM``),
+tankōbon's or a compilation of related/personal galleries
+
+Grouping
+***************************************
+
+Think of this as a namespace for related galleries. It is ideal for grouping
+multi-series galleries, so you use this as the series name. Since tankōbon's also sometimes feature
+a complete series, you can use this for that too. It is not recommended to put tankōbon in both
+**Collection** and here. Choose one and stick to it to avoid confusion.
+**Gallery**'s ``number`` field is used in the context of a **Grouping**.
+
+GalleryFilter
+***************************************
+
+Think of this as those *smart-playlists* in music applications. It's a compilation of galleries put
+together by the user either manually or through automatic search filtering. If you used the old
+Happypanda then you've should already be familiar with this. In old HP they were called gallery lists.
+Recommended usage is "anything". It could range from your favorite fetishes to a shortcut for a
+search filter you're tired of always typing in.
+
+Gallery
+***************************************
+
+A single chapter, then you group these chapters in a **Grouping**.
+
+Special Notes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Gallery
+***************************************
+
+- A **Gallery** can have multiple **Title**, **Artist** and **Parody**
+- A **Gallery** can be in multiple **Collection** and **GalleryFilter**
+- A **Gallery** can only be in **one** **Grouping**
+
+Tags
+***************************************
+
+**Gallery** and **Page** are the only taggable items.
+**Collection** and **Grouping** are *not* taggable, but they can display tags for all the containing **Gallery**.
+
+Alias
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ ...
+
+Parent
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ ...
+
+
 .. image:: _static/schema.png
 
 Exceptions

docs/api_general.html

@@ -163,7 +163,26 @@
       <div class="col-md-3">
         <div id="sidebar" class="bs-sidenav" role="complementary"><ul>
 <li><a class="reference internal" href="#">General</a><ul>
-<li><a class="reference internal" href="#database">Database</a></li>
+<li><a class="reference internal" href="#database">Database</a><ul>
+<li><a class="reference internal" href="#hierarchy">Hierarchy</a></li>
+<li><a class="reference internal" href="#recommended-usage">Recommended Usage</a><ul>
+<li><a class="reference internal" href="#collection">Collection</a></li>
+<li><a class="reference internal" href="#grouping">Grouping</a></li>
+<li><a class="reference internal" href="#galleryfilter">GalleryFilter</a></li>
+<li><a class="reference internal" href="#gallery">Gallery</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#special-notes">Special Notes</a><ul>
+<li><a class="reference internal" href="#id1">Gallery</a></li>
+<li><a class="reference internal" href="#tags">Tags</a><ul>
+<li><a class="reference internal" href="#alias">Alias</a></li>
+<li><a class="reference internal" href="#parent">Parent</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
 <li><a class="reference internal" href="#exceptions">Exceptions</a></li>
 </ul>
 </li>
@@ -177,8 +196,71 @@
 <h1>General<a class="headerlink" href="#general" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="database">
 <h2>Database<a class="headerlink" href="#database" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="hierarchy">
+<h3>Hierarchy<a class="headerlink" href="#hierarchy" title="Permalink to this headline">¶</a></h3>
+<p><strong>Collection</strong> -&gt; <strong>Grouping</strong> -&gt; <strong>Gallery</strong> -&gt; <strong>Page</strong></p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last"><strong>Grouping</strong> is actually not a direct descendant of <strong>Collection</strong> as can be seen below,
+but it is sometimes helpful to think of it as such.</p>
+</div>
+</div>
+<div class="section" id="recommended-usage">
+<h3>Recommended Usage<a class="headerlink" href="#recommended-usage" title="Permalink to this headline">¶</a></h3>
+<div class="section" id="collection">
+<h4>Collection<a class="headerlink" href="#collection" title="Permalink to this headline">¶</a></h4>
+<p>Conventions (e.g. <code class="docutils literal"><span class="pre">C90</span></code>), magazines (e.g. <code class="docutils literal"><span class="pre">Girls</span> <span class="pre">forM</span></code>),
+tankōbon&#8217;s or a compilation of related/personal galleries</p>
+</div>
+<div class="section" id="grouping">
+<h4>Grouping<a class="headerlink" href="#grouping" title="Permalink to this headline">¶</a></h4>
+<p>Think of this as a namespace for related galleries. It is ideal for grouping
+multi-series galleries, so you use this as the series name. Since tankōbon&#8217;s also sometimes feature
+a complete series, you can use this for that too. It is not recommended to put tankōbon in both
+<strong>Collection</strong> and here. Choose one and stick to it to avoid confusion.
+<strong>Gallery</strong>&#8216;s <code class="docutils literal"><span class="pre">number</span></code> field is used in the context of a <strong>Grouping</strong>.</p>
+</div>
+<div class="section" id="galleryfilter">
+<h4>GalleryFilter<a class="headerlink" href="#galleryfilter" title="Permalink to this headline">¶</a></h4>
+<p>Think of this as those <em>smart-playlists</em> in music applications. It&#8217;s a compilation of galleries put
+together by the user either manually or through automatic search filtering. If you used the old
+Happypanda then you&#8217;ve should already be familiar with this. In old HP they were called gallery lists.
+Recommended usage is &#8220;anything&#8221;. It could range from your favorite fetishes to a shortcut for a
+search filter you&#8217;re tired of always typing in.</p>
+</div>
+<div class="section" id="gallery">
+<h4>Gallery<a class="headerlink" href="#gallery" title="Permalink to this headline">¶</a></h4>
+<p>A single chapter, then you group these chapters in a <strong>Grouping</strong>.</p>
+</div>
+</div>
+<div class="section" id="special-notes">
+<h3>Special Notes<a class="headerlink" href="#special-notes" title="Permalink to this headline">¶</a></h3>
+<div class="section" id="id1">
+<h4>Gallery<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
+<ul class="simple">
+<li>A <strong>Gallery</strong> can have multiple <strong>Title</strong>, <strong>Artist</strong> and <strong>Parody</strong></li>
+<li>A <strong>Gallery</strong> can be in multiple <strong>Collection</strong> and <strong>GalleryFilter</strong></li>
+<li>A <strong>Gallery</strong> can only be in <strong>one</strong> <strong>Grouping</strong></li>
+</ul>
+</div>
+<div class="section" id="tags">
+<h4>Tags<a class="headerlink" href="#tags" title="Permalink to this headline">¶</a></h4>
+<p><strong>Gallery</strong> and <strong>Page</strong> are the only taggable items.
+<strong>Collection</strong> and <strong>Grouping</strong> are <em>not</em> taggable, but they can display tags for all the containing <strong>Gallery</strong>.</p>
+<div class="section" id="alias">
+<h5>Alias<a class="headerlink" href="#alias" title="Permalink to this headline">¶</a></h5>
+<blockquote>
+<div>...</div></blockquote>
+</div>
+<div class="section" id="parent">
+<h5>Parent<a class="headerlink" href="#parent" title="Permalink to this headline">¶</a></h5>
+<blockquote>
+<div>...</div></blockquote>
 <img alt="_images/schema.png" src="_images/schema.png" />
 </div>
+</div>
+</div>
+</div>
 <div class="section" id="exceptions">
 <h2>Exceptions<a class="headerlink" href="#exceptions" title="Permalink to this headline">¶</a></h2>
 </div>