# LimitlessLumos
**LimitlessLumos** is a powerful Python package designed to ensure that your Telegram bots or other long-running scripts stay alive indefinitely. By integrating a lightweight Flask web server, **LimitlessLumos** guarantees that your scripts remain active and free from timeouts.
## Features
- **Persistent Uptime**: Keeps your script or bot running indefinitely by utilizing a Flask-based server to prevent timeouts.
- **Flexible Configuration**: Easily customize the server's host and port settings according to your needs.
- **Concurrent Execution**: The Flask server runs in a separate thread, allowing your main script to execute without interruptions.
- **Effortless Integration**: Seamlessly integrates into existing Python scripts or Telegram bots with minimal code changes.
## Installation
To install **LimitlessLumos**, ensure you have Python 3.6 or higher, then install it via pip:
```bash
pip install LimitlessLumos
```
## Usage
Here’s how to use **LimitlessLumos** to ensure your script or bot runs indefinitely, with different configurations available for your convenience:
### Basic Example: Default Flask Server
1. **Create Your Script** (e.g., `my_bot.py`):
```python
from LimitlessLumos import lumosServer
from my_telegram_bot import start_bot # Replace with your bot’s start function
# Start your bot or main script
start_bot()
# Run the default Flask server to keep the script alive
lumosServer()
```
This will run the Flask server with the default settings (`localhost` on port `5000`).
2. **Run Your Script**:
```bash
python my_bot.py
```
### Advanced Usage: Customizing the Flask Server
- **Run on All Interfaces with an Auto-Assigned Port**:
```python
lumosServer("All")
```
This command configures the Flask server to listen on `0.0.0.0` (all available interfaces) with an auto-assigned port, allowing access from any IP address.
- **Specify Host and Port Manually**:
```python
lumosServer(host="0.0.0.0", port="8080")
```
This configuration allows you to define both the host and port manually. For example, setting `host="0.0.0.0"` and `port="8080"` makes the server accessible on all network interfaces at port `8080`.
### Example Script with Custom Configuration:
```python
from LimitlessLumos import lumosServer
from my_telegram_bot import start_bot
# Start your bot or main script
start_bot()
# Example: Custom host and port configuration
lumosServer(host="0.0.0.0", port="8080")
```
## Configuration
**LimitlessLumos** provides flexible configuration options for the underlying Flask server. By adjusting the `lumosServer` parameters, you can control how and where your server runs:
- **Default Settings**: `lumosServer()` starts a Flask server on `localhost` at port `5000`.
- **All Interfaces**: `lumosServer("All")` makes the server accessible from any IP address, with an automatically assigned port.
- **Custom Host and Port**: `lumosServer(host="", port="")` allows you to specify the host and port according to your needs.
## Contributing
Contributions to **LimitlessLumos** are highly encouraged! Whether you have suggestions, bug fixes, or new features, your input is valuable. To contribute:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature`).
3. Commit your changes (`git commit -am 'Add new feature'`).
4. Push to the branch (`git push origin feature/your-feature`).
5. Submit a Pull Request for review.
## License
**LimitlessLumos** is distributed under the [CC-BY-SA 4.0](https://github.com/TraxDinosaur/LimitlessLumos/blob/main/LICENSE) license. You are free to share and adapt the software as long as appropriate credit is given and any derivatives are licensed under the same terms.
## Support
For questions, issues, or support, feel free to reach out to [TraxDinosaur](https://traxdinosaur.github.io). We are here to assist with any challenges you may encounter while using **LimitlessLumos**.
---
By using **LimitlessLumos**, you can confidently keep your scripts and bots running indefinitely, ensuring maximum uptime and reliability.
Raw data
{
"_id": null,
"home_page": "https://github.com/TraxDinosaur/LimitlessLumos",
"name": "LimitlessLumos",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Flask, Telegram bot, keep alive, web server, threading, LimitlessLumos",
"author": "TraxDinosaur",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e5/eb/9a66b373aea2154d609e678394736fb5fa90dca486dcabffb1aa659059b2/limitlesslumos-1.1.0.tar.gz",
"platform": null,
"description": "# LimitlessLumos\r\n\r\n**LimitlessLumos** is a powerful Python package designed to ensure that your Telegram bots or other long-running scripts stay alive indefinitely. By integrating a lightweight Flask web server, **LimitlessLumos** guarantees that your scripts remain active and free from timeouts.\r\n\r\n## Features\r\n\r\n- **Persistent Uptime**: Keeps your script or bot running indefinitely by utilizing a Flask-based server to prevent timeouts.\r\n- **Flexible Configuration**: Easily customize the server's host and port settings according to your needs.\r\n- **Concurrent Execution**: The Flask server runs in a separate thread, allowing your main script to execute without interruptions.\r\n- **Effortless Integration**: Seamlessly integrates into existing Python scripts or Telegram bots with minimal code changes.\r\n\r\n## Installation\r\n\r\nTo install **LimitlessLumos**, ensure you have Python 3.6 or higher, then install it via pip:\r\n\r\n```bash\r\npip install LimitlessLumos\r\n```\r\n\r\n## Usage\r\n\r\nHere\u2019s how to use **LimitlessLumos** to ensure your script or bot runs indefinitely, with different configurations available for your convenience:\r\n\r\n### Basic Example: Default Flask Server\r\n\r\n1. **Create Your Script** (e.g., `my_bot.py`):\r\n\r\n ```python\r\n from LimitlessLumos import lumosServer\r\n from my_telegram_bot import start_bot # Replace with your bot\u2019s start function\r\n\r\n # Start your bot or main script\r\n start_bot()\r\n\r\n # Run the default Flask server to keep the script alive\r\n lumosServer()\r\n ```\r\n\r\n This will run the Flask server with the default settings (`localhost` on port `5000`).\r\n\r\n2. **Run Your Script**:\r\n\r\n ```bash\r\n python my_bot.py\r\n ```\r\n\r\n### Advanced Usage: Customizing the Flask Server\r\n\r\n- **Run on All Interfaces with an Auto-Assigned Port**:\r\n\r\n ```python\r\n lumosServer(\"All\")\r\n ```\r\n\r\n This command configures the Flask server to listen on `0.0.0.0` (all available interfaces) with an auto-assigned port, allowing access from any IP address.\r\n\r\n- **Specify Host and Port Manually**:\r\n\r\n ```python\r\n lumosServer(host=\"0.0.0.0\", port=\"8080\")\r\n ```\r\n\r\n This configuration allows you to define both the host and port manually. For example, setting `host=\"0.0.0.0\"` and `port=\"8080\"` makes the server accessible on all network interfaces at port `8080`.\r\n\r\n### Example Script with Custom Configuration:\r\n\r\n```python\r\nfrom LimitlessLumos import lumosServer\r\nfrom my_telegram_bot import start_bot\r\n\r\n# Start your bot or main script\r\nstart_bot()\r\n\r\n# Example: Custom host and port configuration\r\nlumosServer(host=\"0.0.0.0\", port=\"8080\")\r\n```\r\n\r\n## Configuration\r\n\r\n**LimitlessLumos** provides flexible configuration options for the underlying Flask server. By adjusting the `lumosServer` parameters, you can control how and where your server runs:\r\n\r\n- **Default Settings**: `lumosServer()` starts a Flask server on `localhost` at port `5000`.\r\n- **All Interfaces**: `lumosServer(\"All\")` makes the server accessible from any IP address, with an automatically assigned port.\r\n- **Custom Host and Port**: `lumosServer(host=\"\", port=\"\")` allows you to specify the host and port according to your needs.\r\n\r\n## Contributing\r\n\r\nContributions to **LimitlessLumos** are highly encouraged! Whether you have suggestions, bug fixes, or new features, your input is valuable. To contribute:\r\n\r\n1. Fork the repository.\r\n2. Create a new branch (`git checkout -b feature/your-feature`).\r\n3. Commit your changes (`git commit -am 'Add new feature'`).\r\n4. Push to the branch (`git push origin feature/your-feature`).\r\n5. Submit a Pull Request for review.\r\n\r\n## License\r\n\r\n**LimitlessLumos** is distributed under the [CC-BY-SA 4.0](https://github.com/TraxDinosaur/LimitlessLumos/blob/main/LICENSE) license. You are free to share and adapt the software as long as appropriate credit is given and any derivatives are licensed under the same terms.\r\n\r\n## Support\r\n\r\nFor questions, issues, or support, feel free to reach out to [TraxDinosaur](https://traxdinosaur.github.io). We are here to assist with any challenges you may encounter while using **LimitlessLumos**.\r\n\r\n---\r\n\r\nBy using **LimitlessLumos**, you can confidently keep your scripts and bots running indefinitely, ensuring maximum uptime and reliability.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A package providing a Flask-based server to keep Telegram bots and other scripts running indefinitely.",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/TraxDinosaur/LimitlessLumos"
},
"split_keywords": [
"flask",
" telegram bot",
" keep alive",
" web server",
" threading",
" limitlesslumos"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3e468de378d3c8a1ce2258451dad888e615d9506be84c958a4aba047e515dc95",
"md5": "99b6bb6590d620b2a83660ac2ce816bd",
"sha256": "b9bfdaa1b8d8737e4f49a15d510e2b41895d13aeb2f5a55a6aa7c83aabae8f9b"
},
"downloads": -1,
"filename": "LimitlessLumos-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "99b6bb6590d620b2a83660ac2ce816bd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6379,
"upload_time": "2024-08-16T16:20:01",
"upload_time_iso_8601": "2024-08-16T16:20:01.682888Z",
"url": "https://files.pythonhosted.org/packages/3e/46/8de378d3c8a1ce2258451dad888e615d9506be84c958a4aba047e515dc95/LimitlessLumos-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e5eb9a66b373aea2154d609e678394736fb5fa90dca486dcabffb1aa659059b2",
"md5": "25aeee5090c29cdba0e307a5e7f577ca",
"sha256": "cbef9d1a4269c124e7834bead144d55a83425a8923c4274fe5a5f8d4c233c121"
},
"downloads": -1,
"filename": "limitlesslumos-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "25aeee5090c29cdba0e307a5e7f577ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6192,
"upload_time": "2024-08-16T16:20:03",
"upload_time_iso_8601": "2024-08-16T16:20:03.445843Z",
"url": "https://files.pythonhosted.org/packages/e5/eb/9a66b373aea2154d609e678394736fb5fa90dca486dcabffb1aa659059b2/limitlesslumos-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-16 16:20:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TraxDinosaur",
"github_project": "LimitlessLumos",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "limitlesslumos"
}
JSON
