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 โœจ 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

๐Ÿ› ๏ธ Installation

You can install IPQR easily using pip:

pip install ipqr

๐Ÿš€ 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! ๐Ÿ“ฑโœจ

๐Ÿค 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

0.1.1

This version

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.0.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ipqr-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 148a922cb8484f377fd7b049173a84c626b6b11c8010bcc3498611ff8af83fb7
MD5 670eca69174395c6516476d5bdc6287b
BLAKE2b-256 d8aa765894bc0055e454672490a6d41ecdf474ce250a811cefdb998e688d5a54

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipqr-0.1.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b6b3220b9d0fd898f34902c1cae1c3e000206d04e10c4d8275566114bd8945f2
MD5 d80962ad25a3b3299f3ba95eea69b6fc
BLAKE2b-256 a10901d9c1b801729a5f9d7ed86317dd93085996a00ebd37cf4113b312fae9d4

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