https://github.com/sibyx/griminventory-api

Notion-based invetory with dynamic generation of Brother P-Touch compatible .lbx label files
https://github.com/sibyx/griminventory-api

brother-label-printer brother-ql hacktoberfest inventory-management notion

Last synced: about 1 month ago
JSON representation

Notion-based invetory with dynamic generation of Brother P-Touch compatible .lbx label files

• Host: GitHub
• URL: https://github.com/sibyx/griminventory-api
• Owner: Sibyx
• Created: 2024-09-07T17:55:30.000Z (4 months ago)
• Default Branch: master
• Last Pushed: 2024-09-07T19:33:13.000Z (4 months ago)
• Last Synced: 2024-11-18T20:14:55.630Z (about 1 month ago)
• Topics: brother-label-printer, brother-ql, hacktoberfest, inventory-management, notion
• Language: Jinja
• Homepage:
• Size: 1.32 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Griminventory API

## Overview

**Griminventory API** is a Flask-based service designed to generate QR code labels for items stored in Notion.

The project includes support for Brother P-touch Editor by generating `.lbx` files. Each label contains the Notion

item title and a QR code linking to the item's page.

## Features

- Redirect to Notion page based on item UUID.

- Generate QR codes for Notion items.

- Generate `.lbx` files for Brother P-touch Editor (62mm landscape format).

- Labels include item titles and QR codes linking to the Notion page.

## Installation

## Usage

### Endpoints

| Endpoint                   | Method | Description                                                                               |

|----------------------------|--------|-------------------------------------------------------------------------------------------|

| `/v1/items/:item_uuid`     | GET    | Redirects to the corresponding Notion page using the provided `item_uuid`.                |

| `/v1/items/:item_uuid.png` | GET    | Returns a QR code PNG linking to the Notion page for the given `item_uuid`.               |

| `/v1/items/:item_uuid.lbx` | GET    | Returns a `.lbx` file for Brother P-touch Editor containing the Notion title and QR code. |

### Label example

![](docs/label-example.png)

---

Created with ❤️ using ☕️ and 🍍

If you enjoy using this project, consider donating! Your donations will go towards therapy sessions because

I'm an alcoholic and substance abuser and this is my cry for help. Cheers 🍻!