ipqr

Name	ipqr JSON
Version	0.1.1 JSON
	download
home_page	https://github.com/kasundularaam/ipqr
Summary	A CLI tool to generate QR codes for local server URLs
upload_time	2024-08-18 21:21:57
maintainer	None
docs_url	None
author	Kasun Dulara
requires_python	>=3.6
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 📱 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](https://github.com/kasundularaam/ipqr/issues). 

## 📜 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 🙏 Acknowledgements

- Thanks to the creators of [qrcode](https://github.com/lincolnloop/python-qrcode) and [netifaces](https://github.com/al45tair/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](https://github.com/kasundularaam).

Happy coding! 💻✨

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/kasundularaam/ipqr",
    "name": "ipqr",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": "Kasun Dulara",
    "author_email": "kasundularaam@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/86/c9/255de12e97503e959f6c14046c6baa2a2c4f14e54096064ee1d70fa1d171/ipqr-0.1.1.tar.gz",
    "platform": null,
    "description": "# \ud83d\udcf1 IPQR \ud83d\udda5\ufe0f\r\n\r\nIPQR is a magical \u2728 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! \ud83d\ude80\r\n\r\n## \ud83c\udf1f Features\r\n\r\n- \ud83d\udd0d Automatic local IP detection\r\n- \ud83c\udfa8 ASCII QR code generation\r\n- \ud83d\udd22 Custom port support\r\n- \ud83d\ude80 Easy to use command-line interface\r\n- \ud83d\udc27 Cross-platform support (Windows, macOS, Linux)\r\n\r\n## \ud83d\udee0\ufe0f Installation\r\n\r\nYou can install IPQR easily using pip:\r\n\r\n```\r\npip install ipqr\r\n```\r\n\r\nThis works on Windows, macOS, and Linux!\r\n\r\n## \ud83d\ude80 Usage\r\n\r\n### Basic Usage\r\n\r\nTo use IPQR with the default port (8000):\r\n\r\n```\r\nipqr\r\n```\r\n\r\n### Custom Port\r\n\r\nTo specify a custom port:\r\n\r\n```\r\nipqr -p 5000\r\n```\r\n\r\nor\r\n\r\n```\r\nipqr --port 5000\r\n```\r\n\r\n## \ud83d\udcd6 Example\r\n\r\nHere's what you'll see when you run IPQR:\r\n\r\n```\r\n$ ipqr\r\nLocal server URL: http://192.168.1.100:8000\r\nScan this QR code to access the local server:\r\n\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\r\n\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\r\n\u2588\u2588\u2588\u2588 \u2584\u2584\u2584\u2584\u2584 \u2588 \u2588 \u2588\u2580\u2588\u2584\u2588 \u2584\u2584\u2584\u2584\u2584 \u2588\u2588\u2588\u2588\r\n\u2588\u2588\u2588\u2588 \u2588   \u2588 \u2588\u2584\u2588\u2580\u2588\u2588\u2580 \u2588 \u2588   \u2588 \u2588\u2588\u2588\u2588\r\n\u2588\u2588\u2588\u2588 \u2588\u2584\u2584\u2584\u2588 \u2588\u2580\u2588 \u2588\u2580\u2588\u2588  \u2588\u2584\u2584\u2584\u2588 \u2588\u2588\u2588\u2588\r\n\u2588\u2588\u2588\u2588\u2584\u2584\u2584\u2584\u2584\u2584\u2584\u2588 \u2588 \u2580 \u2588\u2584\u2588\u2584\u2584\u2584\u2584\u2584\u2584\u2584\u2588\u2588\u2588\u2588\r\n\u2588\u2588\u2588\u2588  \u2580\u2584\u2588\u2588\u2584\u2580\u2580\u2580\u2588\u2584\u2580\u2580 \u2588\u2584\u2588\u2580 \u2580\u2584\u2580\u2588\u2588\u2588\u2588\r\n\u2588\u2588\u2588\u2588\u2580\u2580\u2580\u2588\u2588\u2580\u2580\u2584\u2580 \u2580\u2580\u2580\u2580 \u2580\u2588\u2580  \u2580\u2588\u2580\u2588\u2588\u2588\u2588\r\n\u2588\u2588\u2588\u2588 \u2580\u2584\u2580\u2580\u2584\u2584\u2580\u2580\u2580\u2588\u2588\u2580\u2580\u2580\u2588\u2580\u2580\u2584\u2580\u2580\u2584 \u2588\u2588\u2588\u2588\r\n\u2588\u2588\u2588\u2588\u2584\u2588\u2588\u2584\u2584\u2584\u2584\u2580\u2580\u2580\u2584\u2588 \u2584\u2580\u2584\u2580\u2584\u2584\u2584\u2580\u2580\u2584\u2588\u2588\u2588\u2588\r\n\u2588\u2588\u2588\u2588 \u2584\u2584\u2584\u2584\u2584 \u2588\u2584\u2588\u2580 \u2580\u2584\u2588 \u2588 \u2588\u2584\u2588 \u2588\u2588\u2588\u2588\u2588\r\n\u2588\u2588\u2588\u2588 \u2588   \u2588 \u2588  \u2588\u2580\u2580\u2584\u2580\u2580\u2588\u2584  \u2584\u2580\u2588\u2588\u2588\u2588\u2588\r\n\u2588\u2588\u2588\u2588 \u2588\u2584\u2584\u2584\u2588 \u2588\u2580\u2588 \u2588\u2580\u2580 \u2588\u2584\u2588\u2584\u2580\u2588\u2588\u2588\u2588\u2588\u2588\u2588\r\n\u2588\u2588\u2588\u2588\u2584\u2584\u2584\u2584\u2584\u2584\u2584\u2588\u2584\u2588\u2588\u2588\u2584\u2588\u2584\u2588\u2588\u2584\u2588\u2588\u2584\u2588\u2588\u2588\u2588\u2588\u2588\r\n\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\r\n\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\r\n```\r\n\r\nJust scan the QR code with your mobile device, and you're good to go! \ud83d\udcf1\u2728\r\n\r\n## \ud83d\udc27 Linux Users\r\n\r\nIPQR 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.\r\n\r\n## \ud83e\udd1d Contributing\r\n\r\nContributions, issues, and feature requests are welcome! Feel free to check [issues page](https://github.com/kasundularaam/ipqr/issues). \r\n\r\n## \ud83d\udcdc License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## \ud83d\ude4f Acknowledgements\r\n\r\n- Thanks to the creators of [qrcode](https://github.com/lincolnloop/python-qrcode) and [netifaces](https://github.com/al45tair/netifaces) libraries.\r\n- Inspired by the need to quickly share local server addresses during development.\r\n\r\n## \ud83d\ude80 About the Author\r\n\r\nCreated with \u2764\ufe0f by Kasun Dulara. Connect with me on [GitHub](https://github.com/kasundularaam).\r\n\r\nHappy coding! \ud83d\udcbb\u2728\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A CLI tool to generate QR codes for local server URLs",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/kasundularaam/ipqr"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "061bc5b9fc2d7788e134b1d2d40b7a907d33d64ec594e82768c118dea8fc12a5",
                "md5": "6535a9b72560bc6e13ef68fd742518b9",
                "sha256": "b2a47b98791c46fdffbb1596e0796b9a35acc0a9d71a5690c7761255f3a01259"
            },
            "downloads": -1,
            "filename": "ipqr-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6535a9b72560bc6e13ef68fd742518b9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 3550,
            "upload_time": "2024-08-18T21:21:55",
            "upload_time_iso_8601": "2024-08-18T21:21:55.733558Z",
            "url": "https://files.pythonhosted.org/packages/06/1b/c5b9fc2d7788e134b1d2d40b7a907d33d64ec594e82768c118dea8fc12a5/ipqr-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "86c9255de12e97503e959f6c14046c6baa2a2c4f14e54096064ee1d70fa1d171",
                "md5": "59c9ebc273bff3ad54227d706c78594c",
                "sha256": "5e167b9672d4f28496e88b47879e1ba8237ee00da7f1e6d19f23b2c2dc2ef1f6"
            },
            "downloads": -1,
            "filename": "ipqr-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "59c9ebc273bff3ad54227d706c78594c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 3347,
            "upload_time": "2024-08-18T21:21:57",
            "upload_time_iso_8601": "2024-08-18T21:21:57.280347Z",
            "url": "https://files.pythonhosted.org/packages/86/c9/255de12e97503e959f6c14046c6baa2a2c4f14e54096064ee1d70fa1d171/ipqr-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-18 21:21:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kasundularaam",
    "github_project": "ipqr",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "ipqr"
}