## brother\_ql\_web
This is a web service to print labels on Brother QL label printers. While it is primarily focused on the API/GUI part, the corresponding functionality is provided as a library as well.
You need a considerably recent Python 3 version for this software to work.
The web interface is [responsive](https://en.wikipedia.org/wiki/Responsive_web_design).
There is also a screenshot showing [how it looks on a smartphone](./static/images/screenshots/Label-Designer_Phone.png)
### Installation
The easiest way to use this package is to install it from PyPI:
pip install brother_ql_web
Alternatively, you can use brother_ql_web without installing it, straight out of an unpacked source tarball or a VCS checkout.
It is also possible to install it from source for the current interpreter with:
pip install .
In addition to the Python package requirements itself, `fontconfig` should be installed on your system. It is used to identify and inspect fonts on your machine. This package is pre-installed on many Linux distributions. If you are using a Mac, you might want to use [Homebrew](https://brew.sh) to install `fontconfig` using [`brew install fontconfig`](https://formulae.brew.sh/formula/fontconfig).
If you are not able to install or use `fontconfig` for some reasons, `fontra` is available as a fallback. You can install it using the `fontra` extra.
### Configuration file
Grab a copy of the [example configuration file](https://github.com/FriedrichFroebel/brother_ql_web/blob/master/config.example.json) and adjust it to your needs. You can store this file on your device wherever you want - just make sure to remember the full path as you will have to pass it to the CLI.
Some special notes about the values:
* Setting the log level to *DEBUG* will enable the debug mode of *bottle* as well. Additionally, this avoids sending the commands to the printer itself. You most likely do not want to use the *DEBUG* level unless you know what you are doing.
### Startup
To start the server, either run `brother_ql_web` (only works if installed) or `python -m brother_ql_web`. You will always have to pass the path to your configuration file to use.
The most basic call will look like this:
python -m brother_ql_web --configuration $HOME/printers/brother_ql_web/configuration_dev.json
Additional parameters might be passed and will overwrite the values configured in your configuration file. Please refer to the `--help` flag to learn more about the possible flags you might pass.
#### Running with Docker compose
To start the server with Docker compose, create your configuration file `config.json` in the repository root, then run `docker compose up`.
### Usage
Once it is running, access the web interface by opening the page with your browser.
If you run it on your local machine, go to <http://localhost:8013> (You can change the default port 8013 using the `--port` argument). You will then be forwarded by default to the interactive web GUI located at `/labeldesigner`.
All in all, the web server offers:
* a web GUI allowing you to print your labels at `/labeldesigner`,
* an API at `/api/print/text?text=Your_Text&font_size=100&font_family=Minion%20Pro%20(%20Semibold%20)`
to print a label containing 'Your Text' with the specified font properties.
* an API at `/api/print/image` to print a label image passed through the `image` file value.
### About this fork
This repository contains my personal fork of the original repository.
At the moment, there is no real activity in the upstream project, with the last change happening in January 2020. In the meantime, some dependencies got outdated and *Pillow* deprecated and dropped some methods which break the whole application.
Additionally, I think that it makes more sense to let everyone install this package from PyPI and pass a configuration file parameter to it for customization instead of basically hardcoding the configuration file path to `config.json` in the current application directory.
At the moment there are no plans to submit any pull request to the upstream repository.
#### Differences from upstream
* Package requires Python ≥ 3.9.
* Migrate to a package-based structure.
* Ensure compatibility with latest dependency versions.
* Upgrade Bootstrap and drop jQuery as Bootstrap does not rely on it anymore.
* Conform to PEP 8 coding style.
* Add some more printing options, like the number of labels to print for a session.
* Add support for printing images directly.
* Provide fallback for `fontconfig`.
### License
This software is published under the terms of the GPLv3, see the LICENSE file in the repository.
Parts of this package are redistributed software products from third-parties. They are subject to different licenses:
* [Bootstrap](https://github.com/twbs/bootstrap) v5.3.3, MIT License
* [Bootstrap Icons](https://github.com/twbs/icons) v1.11.3, MIT License
* The CSS files received some minor modification to allow the font files to be loaded from the parent directory.
Raw data
{
"_id": null,
"home_page": null,
"name": "brother-ql-web",
"maintainer": "FriedrichFr\u00f6bel",
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": null,
"keywords": "brother, brother_ql, label, printer",
"author": "Philipp Klaus",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ab/05/060b9d5df04c904d721357ce27059e244921da330dc58813af4a7864fcfc/brother_ql_web-0.5.0.tar.gz",
"platform": null,
"description": "## brother\\_ql\\_web\n\nThis is a web service to print labels on Brother QL label printers. While it is primarily focused on the API/GUI part, the corresponding functionality is provided as a library as well.\n\nYou need a considerably recent Python 3 version for this software to work.\n\n\n\nThe web interface is [responsive](https://en.wikipedia.org/wiki/Responsive_web_design).\nThere is also a screenshot showing [how it looks on a smartphone](./static/images/screenshots/Label-Designer_Phone.png)\n\n### Installation\n\nThe easiest way to use this package is to install it from PyPI:\n\n pip install brother_ql_web\n\nAlternatively, you can use brother_ql_web without installing it, straight out of an unpacked source tarball or a VCS checkout.\n\nIt is also possible to install it from source for the current interpreter with:\n\n pip install .\n\n\nIn addition to the Python package requirements itself, `fontconfig` should be installed on your system. It is used to identify and inspect fonts on your machine. This package is pre-installed on many Linux distributions. If you are using a Mac, you might want to use [Homebrew](https://brew.sh) to install `fontconfig` using [`brew install fontconfig`](https://formulae.brew.sh/formula/fontconfig).\n\nIf you are not able to install or use `fontconfig` for some reasons, `fontra` is available as a fallback. You can install it using the `fontra` extra.\n\n### Configuration file\n\nGrab a copy of the [example configuration file](https://github.com/FriedrichFroebel/brother_ql_web/blob/master/config.example.json) and adjust it to your needs. You can store this file on your device wherever you want - just make sure to remember the full path as you will have to pass it to the CLI.\n\nSome special notes about the values:\n\n* Setting the log level to *DEBUG* will enable the debug mode of *bottle* as well. Additionally, this avoids sending the commands to the printer itself. You most likely do not want to use the *DEBUG* level unless you know what you are doing.\n\n### Startup\n\nTo start the server, either run `brother_ql_web` (only works if installed) or `python -m brother_ql_web`. You will always have to pass the path to your configuration file to use.\n\nThe most basic call will look like this:\n\n python -m brother_ql_web --configuration $HOME/printers/brother_ql_web/configuration_dev.json\n\nAdditional parameters might be passed and will overwrite the values configured in your configuration file. Please refer to the `--help` flag to learn more about the possible flags you might pass.\n\n#### Running with Docker compose\n\nTo start the server with Docker compose, create your configuration file `config.json` in the repository root, then run `docker compose up`.\n\n### Usage\n\nOnce it is running, access the web interface by opening the page with your browser.\n\nIf you run it on your local machine, go to <http://localhost:8013> (You can change the default port 8013 using the `--port` argument). You will then be forwarded by default to the interactive web GUI located at `/labeldesigner`.\n\nAll in all, the web server offers:\n\n* a web GUI allowing you to print your labels at `/labeldesigner`,\n* an API at `/api/print/text?text=Your_Text&font_size=100&font_family=Minion%20Pro%20(%20Semibold%20)`\n to print a label containing 'Your Text' with the specified font properties.\n* an API at `/api/print/image` to print a label image passed through the `image` file value.\n\n### About this fork\n\nThis repository contains my personal fork of the original repository.\n\nAt the moment, there is no real activity in the upstream project, with the last change happening in January 2020. In the meantime, some dependencies got outdated and *Pillow* deprecated and dropped some methods which break the whole application.\n\nAdditionally, I think that it makes more sense to let everyone install this package from PyPI and pass a configuration file parameter to it for customization instead of basically hardcoding the configuration file path to `config.json` in the current application directory.\n\nAt the moment there are no plans to submit any pull request to the upstream repository.\n\n#### Differences from upstream\n\n * Package requires Python \u2265 3.9.\n * Migrate to a package-based structure.\n * Ensure compatibility with latest dependency versions.\n * Upgrade Bootstrap and drop jQuery as Bootstrap does not rely on it anymore.\n * Conform to PEP 8 coding style.\n * Add some more printing options, like the number of labels to print for a session.\n * Add support for printing images directly.\n * Provide fallback for `fontconfig`.\n\n### License\n\nThis software is published under the terms of the GPLv3, see the LICENSE file in the repository.\n\nParts of this package are redistributed software products from third-parties. They are subject to different licenses:\n\n* [Bootstrap](https://github.com/twbs/bootstrap) v5.3.3, MIT License\n* [Bootstrap Icons](https://github.com/twbs/icons) v1.11.3, MIT License\n * The CSS files received some minor modification to allow the font files to be loaded from the parent directory.\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "Simple label designer API and web API for Brother QL label printers",
"version": "0.5.0",
"project_urls": {
"Changelog": "https://github.com/FriedrichFroebel/brother_ql_web/blob/master/CHANGELOG.md",
"Homepage": "https://github.com/FriedrichFroebel/brother_ql_web/",
"Issues": "https://github.com/FriedrichFroebel/brother_ql_web//issues",
"Repository": "https://github.com/FriedrichFroebel/brother_ql_web/"
},
"split_keywords": [
"brother",
" brother_ql",
" label",
" printer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3b58ea259a3616ad34d22cd787eab9e93f804212c4a5f43b684c610739aa384e",
"md5": "3901ea054fcde6693ba7b2d631819132",
"sha256": "86d8b377ba77db432b2ad42065fb211ad2ec5d6c0629d3fadaa14d19b32b2591"
},
"downloads": -1,
"filename": "brother_ql_web-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3901ea054fcde6693ba7b2d631819132",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 547706,
"upload_time": "2024-12-22T08:13:38",
"upload_time_iso_8601": "2024-12-22T08:13:38.949448Z",
"url": "https://files.pythonhosted.org/packages/3b/58/ea259a3616ad34d22cd787eab9e93f804212c4a5f43b684c610739aa384e/brother_ql_web-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ab05060b9d5df04c904d721357ce27059e244921da330dc58813af4a7864fcfc",
"md5": "ed3429ccd48a2f022e072a2ffb6a5a44",
"sha256": "3267da3e0460fa7d6f7c3ea7af39a47c44ba017465a9a2aa0ced1d9ddb87a8f3"
},
"downloads": -1,
"filename": "brother_ql_web-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "ed3429ccd48a2f022e072a2ffb6a5a44",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 591385,
"upload_time": "2024-12-22T08:13:41",
"upload_time_iso_8601": "2024-12-22T08:13:41.753334Z",
"url": "https://files.pythonhosted.org/packages/ab/05/060b9d5df04c904d721357ce27059e244921da330dc58813af4a7864fcfc/brother_ql_web-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-22 08:13:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FriedrichFroebel",
"github_project": "brother_ql_web",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "brother-ql-web"
}
JSON
