{"id":21823500,"url":"https://github.com/labbots/niimprintx","last_synced_at":"2025-07-11T15:35:56.525Z","repository":{"id":241100681,"uuid":"787358286","full_name":"labbots/NiimPrintX","owner":"labbots","description":"NiimPrintX is a Python library designed to seamlessly interface with NiimBot label printers via Bluetooth. This library supports a range of models including D11/B21/B1, D110, and B18.","archived":false,"fork":false,"pushed_at":"2024-08-04T00:24:23.000Z","size":6640,"stargazers_count":255,"open_issues_count":36,"forks_count":21,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-07-04T01:03:22.017Z","etag":null,"topics":["niimbot","python3","tkinter"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/labbots.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-16T11:25:31.000Z","updated_at":"2025-07-03T06:14:11.000Z","dependencies_parsed_at":"2024-05-30T12:43:34.132Z","dependency_job_id":"08cc9151-b2ac-4302-a896-7d416cc735fd","html_url":"https://github.com/labbots/NiimPrintX","commit_stats":null,"previous_names":["labbots/niimprintx"],"tags_count":46,"template":false,"template_full_name":null,"purl":"pkg:github/labbots/NiimPrintX","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/labbots%2FNiimPrintX","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/labbots%2FNiimPrintX/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/labbots%2FNiimPrintX/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/labbots%2FNiimPrintX/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/labbots","download_url":"https://codeload.github.com/labbots/NiimPrintX/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/labbots%2FNiimPrintX/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264841833,"owners_count":23671905,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["niimbot","python3","tkinter"],"created_at":"2024-11-27T17:32:42.213Z","updated_at":"2025-07-11T15:35:56.458Z","avatar_url":"https://github.com/labbots.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eNiimPrintX\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/labbots/NiimPrintX/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/release/labbots/NiimPrintX.svg?style=for-the-badge\" alt=\"Latest Release\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/labbots/NiimPrintX/actions/workflows/tag.yaml\"\u003e\u003cimg alt=\"GitHub Actions Workflow Status\" src=\"https://img.shields.io/github/actions/workflow/status/labbots/NiimPrintX/tag.yaml?style=for-the-badge\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/labbots/NiimPrintX/commits/main/\"\u003e\u003cimg alt=\"GitHub commits since latest release\" src=\"https://img.shields.io/github/commits-since/labbots/NiimPrintX/latest?style=for-the-badge\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\n![NiimPrintX](docs/assets/NiimPrintX.gif)\n\nNiimPrintX is a Python library designed to seamlessly interface with NiimBot label printers via Bluetooth. \nIt provides both a Command-Line Interface (CLI) and a Graphical User Interface (GUI) for users to design and print labels efficiently.\n\n## Key Features\n* **Cross-Platform Compatibility:** NiimPrintX works on Windows, macOS, and Linux, ensuring broad usability.\n* **Bluetooth Connectivity:** Effortlessly connect to your NiimBot label printers via Bluetooth.\n* **Comprehensive Model Support:** Compatible with multiple NiimBot printer models (D11, B21, B1, D110, B18).\n* **Dual Interface Options:** Provides both Command-Line Interface (CLI) and Graphical User Interface (GUI) to suit different user preferences.\n* **Custom Label Design:** The GUI app enables users to design labels tailored to specific devices and label sizes.\n* **Advanced Print Settings:** Customize print density, quantity, and image rotation for precise label printing.\n\n## Requirements\nTo run NiimPrintX, you need to have the following installed:\n\n* Python 3.12 or later\n* ImageMagick library\n* Poetry for dependency management\n\n\n## Installation\nTo install NiimPrintX, follow these steps:\n\n* Ensure that ImageMagick is installed and properly configured on your system. You can download it from [here](https://imagemagick.org/script/download.php).\n\nClone the repository:\n\n```shell\ngit clone https://github.com/labbots/NiimPrintX.git\ncd NiimPrintX\n```\nInstall the necessary dependencies using Poetry:\n\n```shell\npython -m venv venv\npoetry install\n```\n\n### Note:\nMacOS specific setup for local development\n\n```shell\nbrew install libffi\nbrew install glib gobject-introspection cairo pkg-config\n\nexport PKG_CONFIG_PATH=\"/usr/local/opt/libffi/lib/pkgconfig\"\nexport LDFLAGS=\"-L/usr/local/opt/libffi/lib\"\nexport CFLAGS=\"-I/usr/local/opt/libffi/include\"\n```\n\n\n## Usage\nNiimPrintX provides both CLI and GUI applications to use the printer.\n\n### Command-Line Interface (CLI)\nThe CLI allows you to print images and get information about the printer models.\n\n#### General CLI Usage\n```shell\nUsage: python -m NiimPrintX.cli [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n  -v, --verbose  Enable verbose logging\n  -h, --help     Show this message and exit.\n\nCommands:\n  info\n  print\n```\n#### Print Command\n```shell\nUsage: python -m NiimPrintX.cli print [OPTIONS]\n\nOptions:\n  -m, --model [b1|b18|b21|d11|d110]\n                                  Niimbot printer model  [default: d110]\n  -d, --density INTEGER RANGE     Print density  [default: 3; 1\u003c=x\u003c=5]\n  -n, --quantity INTEGER          Print quantity  [default: 1]\n  -r, --rotate [0|90|180|270]     Image rotation (clockwise)  [default: 0]\n  --vo INTEGER                    Vertical offset in pixels  [default: 0]\n  --ho INTEGER                    Horizontal offset in pixels  [default: 0]\n  -i, --image PATH                Image path  [required]\n  -h, --help                      Show this message and exit.\n```\n**Example:**\n\n```shell\npython -m NiimPrintX.cli print -m d110 -d 3 -n 1 -r 90 -i path/to/image.png\n```\n\n#### Info Command\n\n```shell\nUsage: python -m NiimPrintX.cli info [OPTIONS]\n\nOptions:\n  -m, --model [b1|b18|b21|d11|d110]\n                                  Niimbot printer model  [default: d110]\n  -h, --help                      Show this message and exit.\n```\n\n**Example:**\n\n```shell\npython -m NiimPrintX.cli info -m d110\n```\n\n### Graphical User Interface (GUI)\nThe GUI application allows users to design labels based on the label device and label size. Simply run the GUI application:\n\n```shell\npython -m NiimPrintX.ui\n```\n\n## Contributing\nContributions are welcome! Please fork the repository and submit a pull request with your improvements.\n\n## Credits\n* Icons made by [Dave Gandy](https://www.flaticon.com/authors/dave-gandy) from [www.flaticon.com](https://www.flaticon.com/)\n* Icons made by [Pixel perfect](https://www.flaticon.com/authors/pixel-perfect) from [www.flaticon.com](https://www.flaticon.com/)\n* Icons made by [Freepik](https://www.freepik.com) from [www.flaticon.com](https://www.flaticon.com/)\n* Icons made by [rddrt](https://www.flaticon.com/authors/rddrt) from [www.flaticon.com](https://www.flaticon.com/)\n* Icons made by [Icongeek26](https://www.flaticon.com/authors/icongeek26) from [www.flaticon.com](https://www.flaticon.com/)\n* Icons made by [SyafriStudio](https://www.flaticon.com/authors/syafristudio) from [www.flaticon.com](https://www.flaticon.com/)\n* Icons made by [Wahyu Adam](https://www.flaticon.com/authors/wahyu-adam) from [www.flaticon.com](https://www.flaticon.com/)\n* Icons made by [meaicon](https://www.flaticon.com/authors/meaicon) from [www.flaticon.com](https://www.flaticon.com/)\n* Icons made by [IconKanan](https://www.flaticon.com/authors/iconkanan) from [www.flaticon.com](https://www.flaticon.com/)\n* Icons made by [kornkun](https://www.flaticon.com/authors/kornkun) from [www.flaticon.com](https://www.flaticon.com/)\n* Icons made by [Rifaldi Ridha Aisy](https://www.flaticon.com/authors/rifaldi-ridha-aisy) from [www.flaticon.com](https://www.flaticon.com/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flabbots%2Fniimprintx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flabbots%2Fniimprintx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flabbots%2Fniimprintx/lists"}