Projects/worblehat
Projects
/
worblehat
3
1
Fork 0
Code Issues 14 Pull Requests Activity
worblehat/README.md

71 lines
2.9 KiB
Markdown
Raw Normal View History

👉👁️👄👁️👈
2023-05-04 17:13:47 +02:00
![worblehat](worblehat.png)
# 👉👁️👄👁️👈
Add readme and requirements
2022-08-16 22:13:48 +02:00
# Worblehat
Initial commit
2023-04-01 20:40:41 +02:00
added modified data fetcher based on the implementation of adrlau, as well as update to the todo in the readme
2023-04-01 21:08:08 +02:00
More information on <https://www.pvv.ntnu.no/pvv/Bokhyllen/Worblehat/>
Add readme and requirements
2022-08-16 22:13:48 +02:00
## What?
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes
2023-05-04 16:17:35 +02:00
Add readme and requirements
2022-08-16 22:13:48 +02:00
Worblehat is a simple library management system written specifically for Programvareverkstedet.
## Why?
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes
2023-05-04 16:17:35 +02:00
Add readme and requirements
2022-08-16 22:13:48 +02:00
Programvareverkstedet is a small community with many books and games. A simple web platform is needed to manage the library. We need to know who owns each item, if we can loan it out and where it is.
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes
2023-05-04 16:17:35 +02:00
Programvareverkstedet har en rekke bøker, og en konstant tilstrøm av nye.
Teoretisk sett skal disse ryddes og kategoriseres jevntlig, men da dette ikke gjøres ofte nok kan det være et varig strev å finne ut hvor bøker står til enhver tid.
Styret har derfor tatt initiativ til å opprette et biblioteksystem for å systematisere bøkene.
Prosjektet har fått navn Worblehat etter en bibliotekar i Terry Pratchetts discworld serie.
added modified data fetcher based on the implementation of adrlau, as well as update to the todo in the readme
2023-04-01 21:08:08 +02:00
Worblehatt har vært påbegynnt flere ganger opp gjennom historien uten å komme i noen form for funksjonell tilstand enda.
Add readme and requirements
2022-08-16 22:13:48 +02:00
## How?
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes
2023-05-04 16:17:35 +02:00
The application is split into frontend and backend. The frontend is written with react-scripts, and communicates with the backed through a REST api.
Add readme and requirements
2022-08-16 22:13:48 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes
2023-05-04 16:17:35 +02:00
The backend is written in Flask, and uses an ORM(SQLAlchemy) to store the data in any kind of SQL database.
added modified data fetcher based on the implementation of adrlau, as well as update to the todo in the readme
2023-04-01 21:08:08 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes
2023-05-04 16:17:35 +02:00
# Technical details
added modified data fetcher based on the implementation of adrlau, as well as update to the todo in the readme
2023-04-01 21:08:08 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes
2023-05-04 16:17:35 +02:00
## Setup
added modified data fetcher based on the implementation of adrlau, as well as update to the todo in the readme
2023-04-01 21:08:08 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes
2023-05-04 16:17:35 +02:00
This project uses [poetry][poetry] as its buildtool as of May 2023.
added modified data fetcher based on the implementation of adrlau, as well as update to the todo in the readme
2023-04-01 21:08:08 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes
2023-05-04 16:17:35 +02:00
```console
$ poetry install
$ poetry run alembic migrate
Start converting the scanner tool into a cli tool The scanner tool is about to become a fullfledged repl, much in the same manner as dibbler. Changes: - Rename `tools/scanner.py` -> `cli/main.py` - Create abstraction layer for Cmd with numbered commands - Create submenu for items - Lots of functionality edits - Fill out more todos in REAMDE
2023-05-06 02:30:24 +02:00
$ poetry run cli
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes
2023-05-04 16:17:35 +02:00
$ poetry run dev
```
added modified data fetcher based on the implementation of adrlau, as well as update to the todo in the readme
2023-04-01 21:08:08 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes
2023-05-04 16:17:35 +02:00
## How to configure
Foreslo en alternativ prosedyre til bygging av databasen
2023-04-02 00:31:12 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes
2023-05-04 16:17:35 +02:00
See `worblehat/config.py` for configurable settings.
Foreslo en alternativ prosedyre til bygging av databasen
2023-04-02 00:31:12 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes
2023-05-04 16:17:35 +02:00
## TODO List
Foreslo en alternativ prosedyre til bygging av databasen
2023-04-02 00:31:12 +02:00
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes
2023-05-04 16:17:35 +02:00
- [ ] High priority:
Start converting the scanner tool into a cli tool The scanner tool is about to become a fullfledged repl, much in the same manner as dibbler. Changes: - Rename `tools/scanner.py` -> `cli/main.py` - Create abstraction layer for Cmd with numbered commands - Create submenu for items - Lots of functionality edits - Fill out more todos in REAMDE
2023-05-06 02:30:24 +02:00
- [X] Data ingestion logic, that will pull data from online databases based on ISBN.
- [ ] Cli version of the program (this is currently being worked on).
- [ ] Web version of the program
- [ ] Setting up a database with all of PVVs books
- [ ] Creating database with user and pw
- [ ] Model all bookshelfs
- [ ] Scan in all books
- [ ] Inner workings
- [X] Ability to create and update bookcases
- [X] Ability to create and update bookcase shelfs
- [~] Ability to create and update bookcase items
- [ ] Ability to search for books
- [ ] Ability to request book loans for PVV members
- [ ] Ability to queue book loans for PVV members
- [ ] Ability to be notified when books are available
- [ ] Ability to be notified when deadlines are due
- [ ] Ascii art of monkey
Misc changes: - Migrate project to use poetry for ease of dependency management and building - Add wsgi prod and dev entrypoints - Start working on a more rigid scanning tool - Remove unused ignores in .gitignore - Update README about changes
2023-05-04 16:17:35 +02:00
- [ ] Low priority:
- [ ] Ability for PVV members to request book loans through the PVV website
- [ ] Ability for PVV members to search for books through the PVV website
- [ ] Discussion
Start converting the scanner tool into a cli tool The scanner tool is about to become a fullfledged repl, much in the same manner as dibbler. Changes: - Rename `tools/scanner.py` -> `cli/main.py` - Create abstraction layer for Cmd with numbered commands - Create submenu for items - Lots of functionality edits - Fill out more todos in REAMDE
2023-05-06 02:30:24 +02:00
- [ ] Should this project run in a separate tty-instance on Dibblers interface, or should they share the tty with some kind of switching ability?
After some discussion with other PVV members, we came up with an idea where we run the programs in separate ttys, and use a set of large mechanical switches connected to a QMK-flashed microcontroller to switch between them.