Skip to main content

📱 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! 💻✨

Metadata

Release files for ipqr 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ipqr 0.1.1
File Size Uploaded
ipqr-0.1.1.tar.gz 3.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ipqr 0.1.1
File Interpreter ABI Platform
ipqr-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 6.9 kB

Release files / ipqr-0.1.1.tar.gz

Download URL ipqr-0.1.1.tar.gz
Size 3.3 kB
Tags Source
SHA-256 checksum
How to use checksums
5e167b9672d4f28496e88b47879e1ba8237ee00da7f1e6d19f23b2c2dc2ef1f6
BLAKE2b-256 checksum
How to use checksums
86c9255de12e97503e959f6c14046c6baa2a2c4f14e54096064ee1d70fa1d171
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.2

Release files / ipqr-0.1.1-py3-none-any.whl

Download URL ipqr-0.1.1-py3-none-any.whl
Size 3.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b2a47b98791c46fdffbb1596e0796b9a35acc0a9d71a5690c7761255f3a01259
BLAKE2b-256 checksum
How to use checksums
061bc5b9fc2d7788e134b1d2d40b7a907d33d64ec594e82768c118dea8fc12a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.2

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page