Skip to main content

Simple Web-based Interface for Scanner written in Python and JavaScript.

Project description

StaticPIE

Simple Web-based Interface for Scanner

Package version License

This is a simple web-based interface for scanners. It allows sharing the scanner via IP address, making it accessible by the web browser. The frontend interface allows users to crop the image and browse previously scanned images.

From a technical perspective, it is simply a SANE scanimage wrapper. There are quite many things to do to make it production (see TODO section).

Requirements

  • Linux
  • SANE (Scanner Access Now Easy) properly configured (scanimage tool)
  • Python >= 3.8
  • [Optionally] NPM (for frontend app building)

Install and run (local user)

pip install swis
swis --ip localhost --port 5520

If successfully executed visit the http://localhost:5520 (Note: http (without s))

❗IMPORTANT❗ Change the IP (localhost above) to a proper host IP address if you want to access the scanner from other computers (or other devices).

Install and run (system service)

Prerequisites

This process requires root privileges, and you need to have Python>=3.8 installed. If the root user does't have the the pip installed, you will have to install it by running the below:

  • Fedora (and similar): sudo dnf install python3-pip
  • Ubuntu (and similar): sudo apt-get install python3-pip

Install and start service

sudo pip3 install swis
sudo swis --ip [HOST IP ADDRESS] --port 5520 -u [USER] -g [GROUP] service install 
sudo swis service start

You can check the status by running: sudo swis service status

❗IMPORTANT❗ Change the IP ([HOST IP ADDRESS] above) to a proper host IP address, and [USER] and [GROUP] to a proper system user (owner of scanned documents).

Upgrade to new version

To upgrade swis to the new version following steps need to be performed (notice that config needs to be provided):

sudo pip install -U swis
sudo swis --ip [HOST IP ADDRESS] --port 5520 -u [USER] -g [GROUP] service install 
sudo swis service start

Screenshots

Welcome screen

Scanning parameters

Scanning in progress

Cropping scanned image

Side menu

List of scanned images

TODO:

  • error handling
  • pip package
  • automatically add service with systemctl
  • better user interface (i.e. image remove button)
  • save as pdf, etc.

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

swis-0.4.4.tar.gz (593.7 kB view details)

Uploaded Source

Built Distribution

swis-0.4.4-py2.py3-none-any.whl (604.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file swis-0.4.4.tar.gz.

File metadata

  • Download URL: swis-0.4.4.tar.gz
  • Upload date:
  • Size: 593.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for swis-0.4.4.tar.gz
Algorithm Hash digest
SHA256 f0de4438cda505b3f111ecaa1a764f436fad9d01ffb73e8a676fd82465e65e0c
MD5 61755085fa83da8b32ce47e38272d49d
BLAKE2b-256 f0a07712b3f7ee73251328f1bd5c5f93ed886363c666ea037a7c33349fd7cabb

See more details on using hashes here.

File details

Details for the file swis-0.4.4-py2.py3-none-any.whl.

File metadata

  • Download URL: swis-0.4.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 604.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for swis-0.4.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b2440b83c33af9596c2ab4ec7cc7128efd1d8457d38af07e71e3f6b7b2351dd1
MD5 77619371dabc54851438f0eb1e443f47
BLAKE2b-256 84eb67cbd2e87f83893f5c955b528ab88a549dc180744db486c6f4d3d04c502b

See more details on using hashes here.

Supported by

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