A CLI tool to generate QR codes for local server URLs

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for kasundularaam from gravatar.com kasundularaam

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License
  • Author: Kasun Dulara
  • Requires: Python >=3.6
Classifiers

Project description

๐Ÿ“ฑ IPQR ๐Ÿ–ฅ๏ธ

IPQR is a magical โœจ cross-platform command-line tool that generates QR codes for your local server URLs. It automatically detects your local IP address and creates a QR code that can be scanned to quickly access your local server from mobile devices. No more typing long IP addresses on your phone! ๐Ÿš€

๐ŸŒŸ Features

  • ๐Ÿ” Automatic local IP detection
  • ๐ŸŽจ ASCII QR code generation
  • ๐Ÿ”ข Custom port support
  • ๐Ÿš€ Easy to use command-line interface
  • ๐Ÿง Cross-platform support (Windows, macOS, Linux)

๐Ÿ› ๏ธ Installation

You can install IPQR easily using pip:

pip install ipqr

This works on Windows, macOS, and Linux!

๐Ÿš€ Usage

Basic Usage

To use IPQR with the default port (8000):

ipqr

Custom Port

To specify a custom port:

ipqr -p 5000

or

ipqr --port 5000

๐Ÿ“– Example

Here's what you'll see when you run IPQR:

$ ipqr
Local server URL: http://192.168.1.100:8000
Scan this QR code to access the local server:
โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–ˆ โ–„โ–„โ–„โ–„โ–„ โ–ˆ โ–ˆ โ–ˆโ–€โ–ˆโ–„โ–ˆ โ–„โ–„โ–„โ–„โ–„ โ–ˆโ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–ˆ โ–ˆ   โ–ˆ โ–ˆโ–„โ–ˆโ–€โ–ˆโ–ˆโ–€ โ–ˆ โ–ˆ   โ–ˆ โ–ˆโ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–ˆ โ–ˆโ–„โ–„โ–„โ–ˆ โ–ˆโ–€โ–ˆ โ–ˆโ–€โ–ˆโ–ˆ  โ–ˆโ–„โ–„โ–„โ–ˆ โ–ˆโ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–ˆโ–„โ–„โ–„โ–„โ–„โ–„โ–„โ–ˆ โ–ˆ โ–€ โ–ˆโ–„โ–ˆโ–„โ–„โ–„โ–„โ–„โ–„โ–„โ–ˆโ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–ˆ  โ–€โ–„โ–ˆโ–ˆโ–„โ–€โ–€โ–€โ–ˆโ–„โ–€โ–€ โ–ˆโ–„โ–ˆโ–€ โ–€โ–„โ–€โ–ˆโ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–ˆโ–€โ–€โ–€โ–ˆโ–ˆโ–€โ–€โ–„โ–€ โ–€โ–€โ–€โ–€ โ–€โ–ˆโ–€  โ–€โ–ˆโ–€โ–ˆโ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–ˆ โ–€โ–„โ–€โ–€โ–„โ–„โ–€โ–€โ–€โ–ˆโ–ˆโ–€โ–€โ–€โ–ˆโ–€โ–€โ–„โ–€โ–€โ–„ โ–ˆโ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–ˆโ–„โ–ˆโ–ˆโ–„โ–„โ–„โ–„โ–€โ–€โ–€โ–„โ–ˆ โ–„โ–€โ–„โ–€โ–„โ–„โ–„โ–€โ–€โ–„โ–ˆโ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–ˆ โ–„โ–„โ–„โ–„โ–„ โ–ˆโ–„โ–ˆโ–€ โ–€โ–„โ–ˆ โ–ˆ โ–ˆโ–„โ–ˆ โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–ˆ โ–ˆ   โ–ˆ โ–ˆ  โ–ˆโ–€โ–€โ–„โ–€โ–€โ–ˆโ–„  โ–„โ–€โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–ˆ โ–ˆโ–„โ–„โ–„โ–ˆ โ–ˆโ–€โ–ˆ โ–ˆโ–€โ–€ โ–ˆโ–„โ–ˆโ–„โ–€โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–ˆโ–„โ–„โ–„โ–„โ–„โ–„โ–„โ–ˆโ–„โ–ˆโ–ˆโ–ˆโ–„โ–ˆโ–„โ–ˆโ–ˆโ–„โ–ˆโ–ˆโ–„โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ

Just scan the QR code with your mobile device, and you're good to go! ๐Ÿ“ฑโœจ

๐Ÿง Linux Users

IPQR is fully compatible with Linux systems! It uses smart IP detection methods that work across different Linux distributions. If you encounter any issues, please report them on our GitHub page.

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome! Feel free to check issues page.

๐Ÿ“œ License

This project is licensed under the MIT License - see the LICENSE file for details.

๐Ÿ™ Acknowledgements

  • Thanks to the creators of qrcode and netifaces libraries.
  • Inspired by the need to quickly share local server addresses during development.

๐Ÿš€ About the Author

Created with โค๏ธ by Kasun Dulara. Connect with me on GitHub.

Happy coding! ๐Ÿ’ปโœจ

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for kasundularaam from gravatar.com kasundularaam

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License
  • Author: Kasun Dulara
  • Requires: Python >=3.6
Classifiers

Release history Release notifications | RSS feed

This version

0.1.1

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ipqr-0.1.1.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

ipqr-0.1.1-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

Details for the file ipqr-0.1.1.tar.gz.

File metadata

  • Download URL: ipqr-0.1.1.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.2

File hashes

Hashes for ipqr-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5e167b9672d4f28496e88b47879e1ba8237ee00da7f1e6d19f23b2c2dc2ef1f6
MD5 59c9ebc273bff3ad54227d706c78594c
BLAKE2b-256 86c9255de12e97503e959f6c14046c6baa2a2c4f14e54096064ee1d70fa1d171

See more details on using hashes here.

File details

Details for the file ipqr-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: ipqr-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 3.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.2

File hashes

Hashes for ipqr-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b2a47b98791c46fdffbb1596e0796b9a35acc0a9d71a5690c7761255f3a01259
MD5 6535a9b72560bc6e13ef68fd742518b9
BLAKE2b-256 061bc5b9fc2d7788e134b1d2d40b7a907d33d64ec594e82768c118dea8fc12a5

See more details on using hashes here.

Supported by

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