# 🚀 Atikin Logger
A lightweight and beginner-friendly Python logging library with colored output.
Easily track your application's flow with clean, timestamped log messages. Created by: Atikin Verse.
---
## ✨ Features
- 🎨 **Colored console output** – Different colors for each log level
- ⏰ **Automatic timestamps** – Every log includes precise timing
- 📁 **File logging** – Optional log saving to files
- 🪶 **Lightweight** – Zero external dependencies
- 🚀 **Simple setup** – One-line import and ready to use
- 🔧 **Customizable** – Configure colors, files, and formats
---
## 📦 Installation
```bash
pip install atikin-logger
````
---
## 🎯 Quick Start
```python
from atikin_logger import log
log.info("Application started successfully")
log.success("User authentication completed")
log.warning("Disk space is running low")
log.error("Failed to connect to database")
log.debug("Variable x = 42")
```
**Console Output (with colors ✨):**
```
[2025-08-28 14:20:11] [INFO] Application started successfully
[2025-08-28 14:20:11] [SUCCESS] User authentication completed
[2025-08-28 14:20:11] [WARNING] Disk space is running low
[2025-08-28 14:20:11] [ERROR] Failed to connect to database
[2025-08-28 14:20:11] [DEBUG] Variable x = 42
```
---
## 🛠 Advanced Usage
### Custom Logger Instance (File Logging)
```python
from atikin_logger import Logger
log = Logger(log_file="logs/app.log")
log.info("This message appears in console and saves to file")
log.error("Error details are also saved for debugging")
```
### Disable Colors
```python
from atikin_logger import Logger
log = Logger(use_colors=False)
log.info("This message has no colors")
```
### Multiple Logger Instances
```python
from atikin_logger import Logger
db_logger = Logger(log_file="logs/database.log")
api_logger = Logger(log_file="logs/api.log")
db_logger.info("Database connection established")
api_logger.debug("API request received: /users")
```
---
## 📚 API Reference
### Logger Class
```python
Logger(log_file=None, use_colors=True)
```
**Parameters:**
* `log_file (str, optional)` – Save logs to a file if provided.
* `use_colors (bool)` – Enable/disable colored output (default: True).
### Log Methods
| Method | Description | Color |
| --------------- | ---------------------- | --------- |
| `log.info()` | Informational messages | 🔵 Blue |
| `log.success()` | Success notifications | 🟢 Green |
| `log.warning()` | Warning messages | 🟡 Yellow |
| `log.error()` | Error reports | 🔴 Red |
| `log.debug()` | Debug information | 🟣 Purple |
---
## 🧪 Examples
### Example 1 – Basic Application Logging
```python
from atikin_logger import log
def main():
log.info("Starting application...")
try:
log.success("Application started successfully")
except Exception as e:
log.error(f"Application failed: {str(e)}")
log.info("Application shutdown")
if __name__ == "__main__":
main()
```
### Example 2 – Web Server Logging
```python
from atikin_logger import Logger
server_log = Logger(log_file="logs/server.log")
def handle_request(request):
server_log.info(f"Request received: {request.path}")
if request.method == "POST":
server_log.debug(f"POST data: {request.data}")
server_log.success("Request processed successfully")
```
### Example 3 – Error Tracking
```python
from atikin_logger import log
def process_data(data):
try:
result = complex_operation(data)
log.success("Data processed successfully")
return result
except ValueError as e:
log.warning(f"Data validation issue: {e}")
return None
except Exception as e:
log.error(f"Unexpected error in process_data: {e}")
raise
```
---
## ❓ FAQ
**Q: Works on all OS?**
A: ✅ Yes, Windows, macOS, Linux. Colors auto-disable if not supported.
**Q: Custom log format?**
A: 🚧 Currently `[timestamp] [LEVEL] message`. Customization planned.
**Q: Disable all logging?**
A: Wrap log calls in a condition.
**Q: Compatible with Python’s built-in logging?**
A: ✅ Yes, it’s standalone and non-conflicting.
---
## 🤝 Contributing
1. Fork repo
2. Create branch: `git checkout -b feature/awesome`
3. Commit changes: `git commit -m 'Add awesome feature'`
4. Push branch: `git push origin feature/awesome`
5. Open Pull Request
---
## 📄 License
Licensed under the **MIT License** – see [LICENSE](LICENSE).
---
## 🐛 Bug Reports
Please open an issue with:
* Description of bug
* Steps to reproduce
* Expected behavior
* Python version & OS
---
## 🌟 Star History
If you find this project useful, please give it a ⭐ on GitHub!
---
## 📞 Support
* Open an issue on GitHub
* Or contact: **[atikinverse@gmail.com](mailto:atikinverse@gmail.com)**
---
## 🌐 Follow Us
| Platform | Username |
| --------- | ----------- |
| Facebook | atikinverse |
| Instagram | atikinverse |
| LinkedIn | atikinverse |
| Twitter/X | atikinverse |
| Threads | atikinverse |
| Pinterest | atikinverse |
| Quora | atikinverse |
| Reddit | atikinverse |
| Tumblr | atikinverse |
| Snapchat | atikinverse |
| Skype | atikinverse |
| GitHub | atikinverse |
---
<div align="center">
Made with ❤️ by the **Atikin Logger Team** 🚀
</div>
```
Raw data
{
"_id": null,
"home_page": "https://github.com/atikinverse/atikin-logger",
"name": "atikin-logger",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "logging, logger, simple, lightweight, colored-output",
"author": "Your Name",
"author_email": "your.email@example.com",
"download_url": "https://files.pythonhosted.org/packages/7f/f8/b854f8e96ac2a2db60b0522f719a93b9f9cf14b905db85007f740daaa60b/atikin-logger-0.1.0.tar.gz",
"platform": null,
"description": "# \ud83d\ude80 Atikin Logger\r\n\r\nA lightweight and beginner-friendly Python logging library with colored output. \r\nEasily track your application's flow with clean, timestamped log messages. Created by: Atikin Verse.\r\n\r\n\r\n\r\n\r\n\r\n\r\n---\r\n\r\n## \u2728 Features\r\n\r\n- \ud83c\udfa8 **Colored console output** \u2013 Different colors for each log level \r\n- \u23f0 **Automatic timestamps** \u2013 Every log includes precise timing \r\n- \ud83d\udcc1 **File logging** \u2013 Optional log saving to files \r\n- \ud83e\udeb6 **Lightweight** \u2013 Zero external dependencies \r\n- \ud83d\ude80 **Simple setup** \u2013 One-line import and ready to use \r\n- \ud83d\udd27 **Customizable** \u2013 Configure colors, files, and formats \r\n\r\n---\r\n\r\n## \ud83d\udce6 Installation\r\n\r\n```bash\r\npip install atikin-logger\r\n````\r\n\r\n---\r\n\r\n## \ud83c\udfaf Quick Start\r\n\r\n```python\r\nfrom atikin_logger import log\r\n\r\nlog.info(\"Application started successfully\")\r\nlog.success(\"User authentication completed\")\r\nlog.warning(\"Disk space is running low\")\r\nlog.error(\"Failed to connect to database\")\r\nlog.debug(\"Variable x = 42\")\r\n```\r\n\r\n**Console Output (with colors \u2728):**\r\n\r\n```\r\n[2025-08-28 14:20:11] [INFO] Application started successfully\r\n[2025-08-28 14:20:11] [SUCCESS] User authentication completed\r\n[2025-08-28 14:20:11] [WARNING] Disk space is running low\r\n[2025-08-28 14:20:11] [ERROR] Failed to connect to database\r\n[2025-08-28 14:20:11] [DEBUG] Variable x = 42\r\n```\r\n\r\n---\r\n\r\n## \ud83d\udee0 Advanced Usage\r\n\r\n### Custom Logger Instance (File Logging)\r\n\r\n```python\r\nfrom atikin_logger import Logger\r\n\r\nlog = Logger(log_file=\"logs/app.log\")\r\nlog.info(\"This message appears in console and saves to file\")\r\nlog.error(\"Error details are also saved for debugging\")\r\n```\r\n\r\n### Disable Colors\r\n\r\n```python\r\nfrom atikin_logger import Logger\r\n\r\nlog = Logger(use_colors=False)\r\nlog.info(\"This message has no colors\")\r\n```\r\n\r\n### Multiple Logger Instances\r\n\r\n```python\r\nfrom atikin_logger import Logger\r\n\r\ndb_logger = Logger(log_file=\"logs/database.log\")\r\napi_logger = Logger(log_file=\"logs/api.log\")\r\n\r\ndb_logger.info(\"Database connection established\")\r\napi_logger.debug(\"API request received: /users\")\r\n```\r\n\r\n---\r\n\r\n## \ud83d\udcda API Reference\r\n\r\n### Logger Class\r\n\r\n```python\r\nLogger(log_file=None, use_colors=True)\r\n```\r\n\r\n**Parameters:**\r\n\r\n* `log_file (str, optional)` \u2013 Save logs to a file if provided.\r\n* `use_colors (bool)` \u2013 Enable/disable colored output (default: True).\r\n\r\n### Log Methods\r\n\r\n| Method | Description | Color |\r\n| --------------- | ---------------------- | --------- |\r\n| `log.info()` | Informational messages | \ud83d\udd35 Blue |\r\n| `log.success()` | Success notifications | \ud83d\udfe2 Green |\r\n| `log.warning()` | Warning messages | \ud83d\udfe1 Yellow |\r\n| `log.error()` | Error reports | \ud83d\udd34 Red |\r\n| `log.debug()` | Debug information | \ud83d\udfe3 Purple |\r\n\r\n---\r\n\r\n## \ud83e\uddea Examples\r\n\r\n### Example 1 \u2013 Basic Application Logging\r\n\r\n```python\r\nfrom atikin_logger import log\r\n\r\ndef main():\r\n log.info(\"Starting application...\")\r\n try:\r\n log.success(\"Application started successfully\")\r\n except Exception as e:\r\n log.error(f\"Application failed: {str(e)}\")\r\n log.info(\"Application shutdown\")\r\n\r\nif __name__ == \"__main__\":\r\n main()\r\n```\r\n\r\n### Example 2 \u2013 Web Server Logging\r\n\r\n```python\r\nfrom atikin_logger import Logger\r\n\r\nserver_log = Logger(log_file=\"logs/server.log\")\r\n\r\ndef handle_request(request):\r\n server_log.info(f\"Request received: {request.path}\")\r\n if request.method == \"POST\":\r\n server_log.debug(f\"POST data: {request.data}\")\r\n server_log.success(\"Request processed successfully\")\r\n```\r\n\r\n### Example 3 \u2013 Error Tracking\r\n\r\n```python\r\nfrom atikin_logger import log\r\n\r\ndef process_data(data):\r\n try:\r\n result = complex_operation(data)\r\n log.success(\"Data processed successfully\")\r\n return result\r\n except ValueError as e:\r\n log.warning(f\"Data validation issue: {e}\")\r\n return None\r\n except Exception as e:\r\n log.error(f\"Unexpected error in process_data: {e}\")\r\n raise\r\n```\r\n\r\n---\r\n\r\n## \u2753 FAQ\r\n\r\n**Q: Works on all OS?**\r\nA: \u2705 Yes, Windows, macOS, Linux. Colors auto-disable if not supported.\r\n\r\n**Q: Custom log format?**\r\nA: \ud83d\udea7 Currently `[timestamp] [LEVEL] message`. Customization planned.\r\n\r\n**Q: Disable all logging?**\r\nA: Wrap log calls in a condition.\r\n\r\n**Q: Compatible with Python\u2019s built-in logging?**\r\nA: \u2705 Yes, it\u2019s standalone and non-conflicting.\r\n\r\n---\r\n\r\n## \ud83e\udd1d Contributing\r\n\r\n1. Fork repo\r\n2. Create branch: `git checkout -b feature/awesome`\r\n3. Commit changes: `git commit -m 'Add awesome feature'`\r\n4. Push branch: `git push origin feature/awesome`\r\n5. Open Pull Request\r\n\r\n---\r\n\r\n## \ud83d\udcc4 License\r\n\r\nLicensed under the **MIT License** \u2013 see [LICENSE](LICENSE).\r\n\r\n---\r\n\r\n## \ud83d\udc1b Bug Reports\r\n\r\nPlease open an issue with:\r\n\r\n* Description of bug\r\n* Steps to reproduce\r\n* Expected behavior\r\n* Python version & OS\r\n\r\n---\r\n\r\n## \ud83c\udf1f Star History\r\n\r\nIf you find this project useful, please give it a \u2b50 on GitHub!\r\n\r\n---\r\n\r\n## \ud83d\udcde Support\r\n\r\n* Open an issue on GitHub\r\n* Or contact: **[atikinverse@gmail.com](mailto:atikinverse@gmail.com)**\r\n\r\n---\r\n\r\n## \ud83c\udf10 Follow Us\r\n\r\n| Platform | Username |\r\n| --------- | ----------- |\r\n| Facebook | atikinverse |\r\n| Instagram | atikinverse |\r\n| LinkedIn | atikinverse |\r\n| Twitter/X | atikinverse |\r\n| Threads | atikinverse |\r\n| Pinterest | atikinverse |\r\n| Quora | atikinverse |\r\n| Reddit | atikinverse |\r\n| Tumblr | atikinverse |\r\n| Snapchat | atikinverse |\r\n| Skype | atikinverse |\r\n| GitHub | atikinverse |\r\n\r\n---\r\n\r\n<div align=\"center\"> \r\nMade with \u2764\ufe0f by the **Atikin Logger Team** \ud83d\ude80 \r\n</div>\r\n```\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A lightweight and beginner-friendly Python logging library",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/atikinverse/atikin-logger"
},
"split_keywords": [
"logging",
" logger",
" simple",
" lightweight",
" colored-output"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1274e0e6e90a08c466670b527f49a8049a4ebf62470369b0b56ddf0cb7424fa6",
"md5": "2e148d561efd0421de85fce1e53fe8ae",
"sha256": "2faa9f8ddcc1247886138e00164303eeeb442307696f6b1df265913a33fd5586"
},
"downloads": -1,
"filename": "atikin_logger-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2e148d561efd0421de85fce1e53fe8ae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6089,
"upload_time": "2025-08-28T16:32:43",
"upload_time_iso_8601": "2025-08-28T16:32:43.526012Z",
"url": "https://files.pythonhosted.org/packages/12/74/e0e6e90a08c466670b527f49a8049a4ebf62470369b0b56ddf0cb7424fa6/atikin_logger-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7ff8b854f8e96ac2a2db60b0522f719a93b9f9cf14b905db85007f740daaa60b",
"md5": "1a722fad9933ed3a056f2ccfae2dfc4a",
"sha256": "c67d50136f08ac94e0eaeef20ae59794d1f427ac90c151e07a455a6a820b003b"
},
"downloads": -1,
"filename": "atikin-logger-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1a722fad9933ed3a056f2ccfae2dfc4a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5748,
"upload_time": "2025-08-28T16:32:45",
"upload_time_iso_8601": "2025-08-28T16:32:45.103040Z",
"url": "https://files.pythonhosted.org/packages/7f/f8/b854f8e96ac2a2db60b0522f719a93b9f9cf14b905db85007f740daaa60b/atikin-logger-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-28 16:32:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "atikinverse",
"github_project": "atikin-logger",
"github_not_found": true,
"lcname": "atikin-logger"
}
JSON
