mirror of
https://github.com/th3r00t/pyShelf.git
synced 2026-04-28 01:59:35 -04:00
Working towards the overhaul of the collections system.
This commit is contained in:
5
wiki/Automated Collections.wiki
vendored
5
wiki/Automated Collections.wiki
vendored
@@ -1,7 +1,7 @@
|
||||
= Automated Collection Management System =
|
||||
The collection management system needs rewritten from the ground up.
|
||||
The model should look something like this.
|
||||
* [ ] TODO :: Refactor collections algorithm. #8f46262c
|
||||
* [ ] TODO :: Refactor collections algorithm. #aebaee91
|
||||
{{{python
|
||||
Collection {
|
||||
id: int
|
||||
@@ -19,3 +19,6 @@ it is likely the book object will need rewritten as well.
|
||||
collection: list(Collection.id)
|
||||
}
|
||||
}}}
|
||||
|
||||
{{file://$HOME/.local/builds/pyShelf/src/backend/lib/storage.py}}
|
||||
{{file://$HOME/.local/builds/pyShelf/src/backend/pyShelf_ScanLibrary.py}}
|
||||
|
||||
20
wiki/Program Flow.wiki
vendored
Normal file
20
wiki/Program Flow.wiki
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
= PyShelf's Program Flow Chart =
|
||||
|
||||
== Entry Point ==
|
||||
{{{bash
|
||||
> ./pyShelf.py
|
||||
}}}
|
||||
=== pyShelf.py ===
|
||||
- from src.backend.pyShelf_ScanLibrary import execute_scan
|
||||
- from src.backend.pyShelf_MakeCollections import MakeCollections
|
||||
- config = Config()
|
||||
- PRG_PATH
|
||||
- Storage(config).create_tables()
|
||||
- Thread(run_import)
|
||||
- FastAPIServer(config)
|
||||
|
||||
==== run_import() ====
|
||||
:bookimport:
|
||||
- execute_scan(PRG_PATH, config) *Book DB Insertion Point*
|
||||
- MakeCollections(PRG_PATH, config) *Collection DB Insertion Point*
|
||||
* [ ] TODO 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
|
||||
6
wiki/index.wiki
vendored
6
wiki/index.wiki
vendored
@@ -38,7 +38,7 @@ pyShelf supports the following formats:
|
||||
== TODO ==
|
||||
* [ ] [[Book Scraping System]] #f7edafb1
|
||||
* [ ] [[REST API]] #c7bc51c5
|
||||
* [ ] [[Client]] #c68b0664
|
||||
* [ ] [[Client]] #21cbc756
|
||||
|
||||
== Development ==
|
||||
|
||||
@@ -48,6 +48,10 @@ pyShelf takes advantage of the following tools:
|
||||
[[https://vimwiki.github.io/|VimWiki]] we also follow
|
||||
[[https://semver.org|semver]] standards.
|
||||
|
||||
|
||||
- [[Program Flow]]
|
||||
|
||||
|
||||
Please note that I use task, vimwiki, & taskwiki to manage my projects.
|
||||
Due to this Task entries marked via `* [ ] task` are postfixed with hex color
|
||||
data. Anyone who knows how to fix that I'm all ears :).
|
||||
|
||||
Reference in New Issue
Block a user