Skip to main content

GUI for flinventory for viewing and editing inventory

Project description

flinventory GUI

Search screenshot

A GUI for the flinventory project/ data format.

Run

Getting code: git clone https://codeberg.org/flukx/flinventory-gui.git

Getting prerequisites:

  • Getting flinventory, which is not published as a package yet:
  • git clone https://codeberg.org/flukx/flinventory.git
    cd flinventory
    nix-shell  # or install pdm your way
    pdm build
    
Then use the way you prefer:
- ```commandline
  conda create -f environment.yml`
  conda activate bikeparts-gui
  pip install flinventory/dist/dist/flinventory-0.1.1-py3-none-any.whl
  • or virtualenv:
    python -m venv .venv
    source .venv/bin/activate
    pip install -r nicegui flinventory/dist/dist/flinventory-0.1.1-py3-none-any.whl
    
  • or nix-shell (unfortunately no working setup found. Please help!)

Getting data: git clone -b harzgerode-main https://codeberg.org/flukx/flings.git Run it:

python flinventory_gui/search.py flings

It should open a browser with the search page. Otherwise, open localhost:11111 in your browser.

To see all options run python flinventory_gui/search.py --help but note that many of them are inherited from the underlying module flinventory and are not used.

Build and install with pip

Building flinventory_gui: pdm build and install in a venv:

python -m venv .venv
source .venv/bin/activate
pip install dist/....whl

But currently it is supported to actually run this installed package.

Making website accessible in local network

It's nice to use the thing search on the computer where it is run but often it's more helpful to use it on other mobile devices. Therefore, you can make the search page available in the local network by opening the port (by default 11111 in the firewall.)

In Fedora KDE I opened "Firewall" and in the Configuration "Runtime" in Tab "Zones" in zone "public" in tab "Ports" added 11111 for protocol tcp.

In NixOS KDE I typed (for temporary access):

sudo iptables -A INPUT -p tcp --dport 11111 -j ACCEPT
sudo systemctl reload firewall

For permanent usage, use the configuration.nix with the line networking.firewall.allowedTCPPorts = [ 11111 ];.

Ideas for the future

  • Somehow really make the search async. Since filtering the correct parts and displaying them has no waiting periods (with await) it cannot really be cancelled.
    • Also helpful: show only 10 best results.
  • Add filter for search that shows a bike where you can click on parts. And then only parts that are "part_of" this are shown. When clicked on the brakes, it shows a list of brake types (sub categories) that you can click on again. Interactive image could be helpful.
    • Make this filter keyboard accessible. Ctrl+F activates choice, then letter chooses something which is marked in the text on the bike picture.
  • Figure out why sometimes the page reloads completely.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flinventory_gui-0.2.0.tar.gz (39.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flinventory_gui-0.2.0-py3-none-any.whl (43.4 kB view details)

Uploaded Python 3

File details

Details for the file flinventory_gui-0.2.0.tar.gz.

File metadata

  • Download URL: flinventory_gui-0.2.0.tar.gz
  • Upload date:
  • Size: 39.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.22.3 CPython/3.12.9 Linux/6.12.19

File hashes

Hashes for flinventory_gui-0.2.0.tar.gz
Algorithm Hash digest
SHA256 e7dc90a76714e18e45bca0d5278f1839fe416d0eee213a3738710226fdb3285b
MD5 dce45c50cc3d898c826b605d36a010fe
BLAKE2b-256 49019a6a1a7fd30b44d6c9159104d45308354f80ca68a016dc1c488a40be2fc9

See more details on using hashes here.

File details

Details for the file flinventory_gui-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: flinventory_gui-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 43.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.22.3 CPython/3.12.9 Linux/6.12.19

File hashes

Hashes for flinventory_gui-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c6db06d007957d07387143981c0fa3ffa770dcea8332087b45f5bafaefba3772
MD5 bc323471c95c1bacc2bfb4a4f4e3be82
BLAKE2b-256 0abb8196134ec23ec76a7301ffde9d5bb0707cc38fa22f041ccf46f37c0e358c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page