|
1 | | -# LabelPush - Lightweight label printing app |
| 1 | +# LabelPush |
| 2 | +## Simple lightweight label printing app |
2 | 3 |
|
3 | 4 | - License: MIT License |
4 | 5 | - Author: Matteljay |
5 | 6 | - Language: Python (>= 3.5) |
6 | 7 | - Homepage: https://github.com/Matteljay |
7 | 8 |
|
| 9 | + |
8 | 10 | ## Screenshots |
9 | 11 |
|
10 | 12 |  |
11 | 13 |  |
12 | 14 |  |
13 | 15 |  |
14 | 16 |
|
15 | | -## Getting started |
16 | 17 |
|
17 | | -LabelPush is a lightweight label printing application written in Python. |
18 | | -It is built to be fast and simple to use. The CUPS printing system is |
19 | | -used. So make sure the printer is correctly installed with all default |
20 | | -settings such as label size. This link should take you to your local |
| 18 | +## Introduction |
| 19 | + |
| 20 | +LabelPush is a simple lightweight label printing application written in Python. |
| 21 | +It is built to be fast and simple to use. The CUPS printing system is used. |
| 22 | +Please make sure the printer is correctly installed with all correct |
| 23 | +settings such as label/paper size. This link should take you to your local |
21 | 24 | settings: [CUPS-localhost](http://localhost:631/printers/) |
22 | 25 |
|
| 26 | + |
23 | 27 | ## Installation |
24 | 28 |
|
25 | | -Two libraries, the Kivy cross-platform GUI and Pillow imaging library |
26 | | -are required for LabelPush. Arch Linux (Manjaro) is very up-to-date, |
27 | | -installation will be very quick. This will be briefly explained below. |
| 29 | +Package dependencies are kept to a minimum. The proper installation guides |
| 30 | +for your system can be found via these links: |
28 | 31 |
|
29 | | -Unfortunately most Debian-based systems like Linux Mint and Ubuntu Linux |
30 | | -do not have the required up-to-date versions of these libraries. |
| 32 | +- [Kivy](https://kivy.org/doc/stable/installation/installation.html) & [Pillow](https://python-pillow.org/) |
| 33 | +Version 1.10.1 with SDL2 window provider are required! (NOT 1.9 with PyGame). |
| 34 | +An updated Python Imaging Library is always recommended with a graphical Python program. And definitely required for LabelPush. |
31 | 35 |
|
32 | | -However the requirements can be compiled and installed via the Python |
33 | | -package management system 'pip'. To be able to compile, install at least |
34 | | -these system packages via apt-get or the Synaptic Package Manager: |
| 36 | +- [pip3](https://github.com/pypa/pip) & [setuptools](https://github.com/pypa/setuptools) |
| 37 | +These are Python 3 installation tools. Universally useful! |
35 | 38 |
|
36 | | - sudo apt-get install python3-pip python3-dev python3-setuptools \ |
37 | | - libgl1-mesa-dev xclip |
| 39 | +- [CUPS](https://www.cups.org/) |
| 40 | +Printer server for macOS and other UNIX-like operating systems. |
38 | 41 |
|
39 | | -### Option 1 |
| 42 | +### Debian Linux |
40 | 43 |
|
41 | | -Now, get a copy of LabelPush. The 'whl' file from the |
42 | | -[releases-page](https://github.com/Matteljay/labelpush/releases) is |
43 | | -the easiest to work with. It does not require extracting, simply run: |
| 44 | +For most up-to-date Debian based systems like Ubuntu Linux and Linux Mint this should work *as root*: |
44 | 45 |
|
45 | | - sudo pip3 install /path/to/file.whl |
| 46 | + add-apt-repository ppa:kivy-team/kivy |
| 47 | + apt-get install python3-kivy python3-pip python3-setuptools |
| 48 | + pip3 install --upgrade pillow labelpush |
46 | 49 |
|
47 | | -All of the requirements should now get downloaded, compiled and |
48 | | -automatically installed. This can take a while. When finished, the |
49 | | -shortcut can be found from your menu-bar in the 'Office' category. |
50 | | -If the icon does not show up, you may need to restart your desktop. |
| 50 | +### Arch Linux |
51 | 51 |
|
52 | | -### Option 2 |
| 52 | +For the more up-to-date Arch Linux (Manjaro) simply run *as root*: |
53 | 53 |
|
54 | | -Alternatively, you can install from tar.gz or the GitHub master tree. |
55 | | -First, extract the archive. Then run from within the extracted folder: |
| 54 | + pacman -S python-kivy python-pillow python-pip python-setuptools |
| 55 | + pip3 install labelpush |
56 | 56 |
|
57 | | - sudo pip3 install . |
58 | 57 |
|
59 | | -### Option 3 |
| 58 | +## How to launch |
60 | 59 |
|
61 | | -Alternatively, you can run it without installing to the root |
62 | | -filesystem. Again, extract the downloaded archive. Then run: |
| 60 | +When finished, the shortcut icon can be found from your menu-bar in the **Office** category. |
| 61 | +If the icon does not show up, you may need to restart your desktop. |
| 62 | +Alternatively, open your graphical user terminal and type **labelpush.py** |
63 | 63 |
|
64 | | - pip3 install --user -r requirements.txt |
65 | | - ./labelpush.py |
66 | 64 |
|
67 | | -### Arch Linux |
| 65 | +## For developers, hackers and testers |
68 | 66 |
|
69 | | -Now, let's have a look at Arch Linux. Install these packages: |
| 67 | +Other ways to install are explained below. The above dependencies are still required! |
| 68 | +Only use the info below if you know what you are doing. |
70 | 69 |
|
71 | | - sudo pacman -S python-kivy python-pillow python-setuptools cython |
| 70 | +### Option 1 |
72 | 71 |
|
73 | | -You can now choose from the 3 methods above, they will execute much |
74 | | -faster as no compilations are required: |
| 72 | +You can install from tar.gz or the GitHub master tree. |
| 73 | +First, download and extract the archive from the [releases](https://github.com/Matteljay/labelpush/releases) page. |
| 74 | +Then run from within the extracted folder: |
75 | 75 |
|
76 | | - sudo pip3 install /path/to/file.whl |
77 | 76 | sudo pip3 install . |
78 | | - ./labelpush.py |
79 | | - |
80 | 77 |
|
81 | | -## Development version |
82 | | - |
83 | | -Optionally, you can use git: |
84 | | - |
85 | | - git clone git://github.com/Matteljay/labelpush.git |
86 | | - cd labelpush |
| 78 | +### Option 2 |
87 | 79 |
|
88 | | -This should install dependencies: |
| 80 | +Alternatively, you can run it without installing to the root |
| 81 | +filesystem. Again, extract the downloaded archive. Then run: |
89 | 82 |
|
90 | 83 | pip3 install --user -r requirements.txt |
| 84 | + ./labelpush.py |
91 | 85 |
|
92 | 86 |
|
93 | | -## Other platforms |
94 | | - |
95 | | - |
96 | | -### Linux distributions |
97 | | - |
98 | | -This application should work on other up-to-date flavors of Linux like |
99 | | -Slackware, Gentoo, openSUSE, Fedora, Red Hat, Mandriva, CentOS,... |
| 87 | +## More platforms |
100 | 88 |
|
101 | | -FreeBSD (TrueOS) and macOS are Linux based but are also untested. |
| 89 | +### Other UNIX |
102 | 90 |
|
| 91 | +Other flavors of Linux are untested but there is no reason for them |
| 92 | +not to work. Slackware, Gentoo, openSUSE, Fedora, Red Hat, Mandriva, CentOS,... |
103 | 93 |
|
104 | | -### Windows |
| 94 | +### Android, iPhone and Windows |
105 | 95 |
|
106 | | -Although Python and the required libraries are cross-platform, this |
107 | | -application will not work on Windows due to the big difference in |
108 | | -printer software (no CUPS). If a strong desire exists, find a way to |
| 96 | +These platforms probably won't work as they feature different printer |
| 97 | +software (no CUPS). If a strong desire exists, find a way to |
109 | 98 | motivate me :-) |
110 | 99 |
|
111 | 100 |
|
112 | | -## Contact info & Donations |
| 101 | +## Contact info & donations |
113 | 102 |
|
114 | | -See [contact](CONTACT.md) file. |
| 103 | +See the [contact](CONTACT.md) file on GitHub. |
115 | 104 |
|
116 | 105 |
|
0 commit comments