streamlog 3.0.0

A Python package to send print statements to an API while printing to the console.

StreamLog

StreamLog is a Python package that extends the functionality of the print statement by simultaneously sending printed messages to an API. It’s designed to help developers log important information to remote servers while maintaining console output.

---

Features

• Seamlessly integrates with the standard print function.
• Sends printed messages to a specified API endpoint.
• Retains all original print functionality, including custom separators, end characters, and file output.

---

Installation

Install the package using pip:

pip install StreamLog

---

Usage

Enable StreamLog

To start using StreamLog, import and enable the custom print functionality by specifying your API endpoint:

from StreamLog import enable_stream_log

# Enable StreamLog with your API endpoint
enable_stream_log(api_url="https://your-api-endpoint.com/logs")

# Use the print function as usual
print("Hello, World!")

Example Output

Console Output:

Hello, World!

API Request:

Endpoint: https://your-api-endpoint.com/logs
Method: POST Payload:

{
  "message": "Hello, World!"
}

---

Parameters

The enable_stream_log function accepts the following parameter:

• api_url (str): The URL of the API endpoint where logs will be sent.
  Default: http://example.com/api/logs

---

Error Handling

If the API call fails (e.g., network issues, invalid endpoint), an error message is displayed in the console, and the print statement continues to function normally.

Example:

StreamLog Error: Failed to send message to API: [Error details]

---

Requirements

• Python 3.6 or higher
• requests library

---

Installation from Source

Clone the repository and install the package locally:

git clone https://github.com/PrathmeshSoni/StreamLog.git
cd StreamLog
pip install .

---

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch (feature/new-feature).
3. Commit your changes.
4. Open a pull request.

---

License

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

---

Contact

Developed by Prathmesh Soni
For more details, visit GitHub Repo.

Let me know if you'd like any modifications!