th3r00t/pyShelf
1
0
Fork 0
mirror of https://github.com/th3r00t/pyShelf.git synced 2026-04-28 01:59:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Working towards the overhaul of the collections system.

Browse Source
This commit is contained in:
th3r00t
2023-03-20 20:42:20 -04:00
parent 3e89273cbc
commit 4ec85dfd82
11 changed files with 149 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/Automated Collections.html
View File

@@ -16,7 +16,7 @@ The model should look something like this.
</p>
<ul>
<li class="done0">
<span class="todo">TODO</span> :: Refactor collections algorithm. #8f46262c
<span class="todo">TODO</span> :: Refactor collections algorithm. #aebaee91
<pre python>
Collection {
id: int
@@ -38,5 +38,10 @@ it is likely the book object will need rewritten as well.
}
</pre>
<p>
<img src="/home/th3r00t/.local/builds/pyShelf/src/backend/lib/storage.py" />
<img src="/home/th3r00t/.local/builds/pyShelf/src/backend/pyShelf_ScanLibrary.py" />
</p>
</body>
</html>

59
docs/Program Flow.html Normal file
View File

@@ -0,0 +1,59 @@
<!DOCTYPE html>
<html>
<head>
<link rel="Stylesheet" type="text/css" href="style.css">
<link rel="alternate" type="application/rss+xml" title="RSS" href="rss.xml">
<title>Program Flow</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<div id="PyShelf's Program Flow Chart"><h1 id="PyShelf's Program Flow Chart" class="header"><a href="#PyShelf's Program Flow Chart">PyShelf's Program Flow Chart</a></h1></div>
<div id="PyShelf's Program Flow Chart-Entry Point"><h2 id="Entry Point" class="header"><a href="#PyShelf's Program Flow Chart-Entry Point">Entry Point</a></h2></div>
<pre bash>
&gt; ./pyShelf.py
</pre>
<div id="PyShelf's Program Flow Chart-Entry Point-pyShelf.py"><h3 id="pyShelf.py" class="header"><a href="#PyShelf's Program Flow Chart-Entry Point-pyShelf.py">pyShelf.py</a></h3></div>
<ul>
<li>
from src.backend.pyShelf_ScanLibrary import execute_scan
<li>
from src.backend.pyShelf_MakeCollections import MakeCollections
<li>
config = Config()
<li>
PRG_PATH
<li>
Storage(config).create_tables()
<li>
Thread(run_import)
<li>
FastAPIServer(config)
</ul>
<div id="PyShelf's Program Flow Chart-Entry Point-pyShelf.py-run_import()"><h4 id="run_import()" class="header"><a href="#PyShelf's Program Flow Chart-Entry Point-pyShelf.py-run_import()">run_import()</a></h4></div>
<p>
<span id="PyShelf's Program Flow Chart-Entry Point-pyShelf.py-run_import()-bookimport"></span><span class="tag" id="bookimport">bookimport</span>
</p>
<ul>
<li>
execute_scan(PRG_PATH, config) <span id="PyShelf's Program Flow Chart-Entry Point-pyShelf.py-run_import()-Book DB Insertion Point"></span><strong id="Book DB Insertion Point">Book DB Insertion Point</strong>
<li>
MakeCollections(PRG_PATH, config) <span id="PyShelf's Program Flow Chart-Entry Point-pyShelf.py-run_import()-Collection DB Insertion Point"></span><strong id="Collection DB Insertion Point">Collection DB Insertion Point</strong>
<li class="done0">
<span class="todo">TODO</span> Move collections insertion to run in tandem with book insertion as this is the last time we have all of the information in one place. #a34ad104
</ul>
</body>
</html>

10
docs/index.html
View File

@@ -108,7 +108,7 @@ Filesystem-io
<a href="REST API.html">REST API</a> #c7bc51c5
<li class="done0">
<a href="Client.html">Client</a> #c68b0664
<a href="Client.html">Client</a> #21cbc756
</ul>
<div id="pyShelf | project:pyshelf-Development"><h2 id="Development" class="header"><a href="#pyShelf | project:pyshelf-Development">Development</a></h2></div>
@@ -123,6 +123,14 @@ pyShelf takes advantage of the following tools:
<a href="https://semver.org">semver</a> standards.
</p>
<ul>
<li>
<a href="Program Flow.html">Program Flow</a>
</ul>
<p>
Please note that I use task, vimwiki, &amp; taskwiki to manage my projects.
Due to this Task entries marked via <code>* [ ] task</code> are postfixed with hex color