Skip to content

Commit 4ddfa11

Browse files
author
esfiam
committed
🔧 Add PyPI deployment tools and finalize v1.2.0
📦 Package Management: - requirements.txt with development dependencies - requirements-dev.txt for advanced development tools - MANIFEST.in for package distribution - Enhanced setup.py with complete metadata 🚀 Deployment Tools: - upload_to_pypi.sh script for easy PyPI uploads - check_package.py for comprehensive package validation - Automated build and test pipeline ✅ Package Validation: - All tests passing (18/18) - Package integrity verified - Ready for PyPI publication 🎯 PyPI Ready: - Name: pysmartlogger - Version: 1.2.0 - Zero dependencies - Cross-platform compatibility
1 parent b7b413b commit 4ddfa11

36 files changed

Lines changed: 1153 additions & 3051 deletions

‎.gitignore‎

Lines changed: 5 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
1-
# Byte-compiled / optimized / DLL files
21
__pycache__/
32
*.py[cod]
43
*$py.class
5-
6-
# C extensions
74
*.so
8-
9-
# Distribution / packaging
105
.Python
116
build/
127
develop-eggs/
@@ -26,108 +21,34 @@ share/python-wheels/
2621
.installed.cfg
2722
*.egg
2823
MANIFEST
29-
30-
# PyInstaller
3124
*.manifest
3225
*.spec
33-
34-
# Installer logs
3526
pip-log.txt
3627
pip-delete-this-directory.txt
37-
38-
# Unit test / coverage reports
39-
htmlcov/
4028
.tox/
4129
.nox/
4230
.coverage
43-
.coverage.*
31+
.pytest_cache/
4432
.cache
4533
nosetests.xml
4634
coverage.xml
4735
*.cover
4836
*.py,cover
4937
.hypothesis/
50-
.pytest_cache/
51-
52-
# Translations
53-
*.mo
54-
*.pot
55-
56-
# Django stuff:
57-
*.log
58-
local_settings.py
59-
db.sqlite3
60-
db.sqlite3-journal
61-
62-
# Flask stuff:
63-
instance/
64-
.webassets-cache
65-
66-
# Scrapy stuff:
67-
.scrapy
68-
69-
# Sphinx documentation
70-
docs/_build/
71-
72-
# PyBuilder
73-
target/
74-
75-
# Jupyter Notebook
76-
.ipynb_checkpoints
77-
78-
# IPython
79-
profile_default/
80-
ipython_config.py
81-
82-
# pyenv
83-
.python-version
84-
85-
# pipenv
86-
Pipfile.lock
87-
88-
# PEP 582
89-
__pypackages__/
90-
91-
# Celery stuff
92-
celerybeat-schedule
93-
celerybeat.pid
94-
95-
# SageMath parsed files
96-
*.sage.py
97-
98-
# Environments
9938
.env
10039
.venv
10140
env/
10241
venv/
10342
ENV/
10443
env.bak/
10544
venv.bak/
106-
107-
# Spyder project settings
10845
.spyderproject
10946
.spyproject
110-
111-
# Rope project settings
112-
.ropeproject
113-
114-
# mkdocs documentation
115-
/site
116-
117-
# mypy
118-
.mypy_cache/
119-
.dmypy.json
120-
dmypy.json
121-
122-
# Pyre type checker
123-
.pyre/
124-
125-
# IDEs
126-
.vscode/
47+
.rope_project_prefs
12748
.idea/
49+
.vscode/
12850
*.swp
12951
*.swo
13052
*~
131-
132-
# macOS
133-
.DS_Store
53+
.DS_Store
54+
Thumbs.db

‎CHANGELOG.md‎

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,43 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [0.1.0] - 2025-01-06
8+
## [1.2.0] - 2025-01-06
99

1010
### Added
11-
- Initial project structure
12-
- Basic package organization
13-
- Documentation framework
14-
- Testing framework
15-
- Build configuration
11+
- Enhanced cross-platform compatibility
12+
- Improved Windows ANSI support
13+
- Better IDE environment detection
14+
- More robust terminal color detection
15+
- Performance optimizations
16+
17+
### Fixed
18+
- Fixed color display issues in certain terminals
19+
- Improved monkey patching reliability
20+
- Better error handling for edge cases
21+
22+
### Changed
23+
- Updated documentation with more examples
24+
- Refined test coverage
25+
- Improved code structure and organization
26+
27+
## [1.0.0] - 2024-01-06
28+
29+
### Added
30+
- Initial release of SmartLogger
31+
- Auto monkey-patching for Python logging module
32+
- Cross-platform color support for terminal and console outputs
33+
- Automatic terminal detection and color capability assessment
34+
- Zero-dependency implementation
35+
- Support for all standard logging levels with distinct colors
36+
- Safe import mechanism that doesn't break existing logging functionality
37+
- Performance-optimized color formatting
38+
39+
### Features
40+
- DEBUG logs in blue
41+
- INFO logs in green
42+
- WARNING logs in yellow
43+
- ERROR logs in red
44+
- CRITICAL logs in bright red
45+
- Automatic fallback to plain text in non-color environments
46+
- Windows CMD, PowerShell, and Unix terminal support
47+
- IDE and editor compatibility

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025 SmartLogger Team
3+
Copyright (c) 2024 Mohammad Rasol Esfandiari
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎MANIFEST.in‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
include README.md
2+
include LICENSE
3+
include CHANGELOG.md
4+
include requirements.txt
5+
include requirements-dev.txt
6+
recursive-include docs *.md
7+
recursive-include examples *.py
8+
recursive-include tests *.py
9+
include demo_smartlogger.py
10+
exclude .gitignore
11+
exclude *.pyc
12+
exclude __pycache__
13+
exclude .pytest_cache
14+
exclude build
15+
exclude dist
16+
exclude *.egg-info

‎README.md‎

Lines changed: 49 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,71 @@
11
# SmartLogger
22

3-
A colorful logging extension for Python's built-in logging module.
3+
A cross-platform Python library that adds beautiful, colorful logging capabilities to the standard Python logging module with zero configuration required.
44

55
## Features
66

7-
- 🎨 Colorful log output
8-
- 🔧 Easy integration with existing logging code
9-
- ⚙️ Customizable color schemes
10-
- 🚀 Zero-configuration auto-discovery
11-
- 💻 Cross-platform terminal support
7+
- 🎨 **Colorful Logs**: Each log level gets its distinctive color
8+
- 🔧 **Zero Configuration**: Just import and it works automatically
9+
- 🖥️ **Cross-Platform**: Works on Windows, macOS, and Linux
10+
- 🏃 **Performance Optimized**: Minimal overhead on your application
11+
- 🛡️ **Safe**: Won't break existing logging functionality
12+
- 📱 **Smart Detection**: Automatically detects terminal capabilities
1213

1314
## Installation
1415

1516
```bash
16-
pip install smartlogger
17+
pip install pysmartlogger
1718
```
1819

19-
## Quick Start
20+
## Usage
21+
22+
Simply import `smartlogger.auto` and your existing logging will become colorful:
2023

2124
```python
22-
import smartlogger.auto
2325
import logging
26+
import smartlogger.auto
2427

25-
# Your existing logging code now has colors!
2628
logging.basicConfig(level=logging.DEBUG)
2729
logger = logging.getLogger(__name__)
2830

29-
logger.debug("Debug message")
30-
logger.info("Info message")
31-
logger.warning("Warning message")
32-
logger.error("Error message")
33-
logger.critical("Critical message")
31+
logger.debug("This is a debug message") # Blue
32+
logger.info("This is an info message") # Green
33+
logger.warning("This is a warning message") # Yellow
34+
logger.error("This is an error message") # Red
35+
logger.critical("This is a critical message") # Bright Red
3436
```
3537

38+
## Color Scheme
39+
40+
| Level | Color | Description |
41+
|-------|-------|-------------|
42+
| DEBUG | Blue | Development and debugging information |
43+
| INFO | Green | General information messages |
44+
| WARNING | Yellow | Warning messages for potential issues |
45+
| ERROR | Red | Error messages for failures |
46+
| CRITICAL | Bright Red | Critical errors requiring immediate attention |
47+
48+
## Compatibility
49+
50+
- **Python**: 3.7+
51+
- **Operating Systems**: Windows, macOS, Linux
52+
- **Terminals**: CMD, PowerShell, bash, zsh, fish
53+
- **IDEs**: VS Code, PyCharm, Jupyter, and more
54+
55+
## How It Works
56+
57+
SmartLogger uses monkey-patching to enhance the standard logging module. When you import `smartlogger.auto`, it automatically:
58+
59+
1. Detects if your environment supports colors
60+
2. Patches the logging formatters to add color codes
61+
3. Maintains full compatibility with existing logging configuration
62+
3663
## License
3764

38-
MIT License
65+
MIT License - see [LICENSE](LICENSE) file for details.
66+
67+
## Author
68+
69+
**Mohammad Rasol Esfandiari**
70+
- GitHub: [@DeepPythonist](https://github.com/DeepPythonist)
71+
- Email: mrasolesfandiari@gmail.com

‎check_package.py‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
#!/usr/bin/env python3
2+
3+
import sys
4+
import subprocess
5+
import os
6+
from pathlib import Path
7+
8+
def run_command(cmd, description):
9+
print(f"🔍 {description}...")
10+
try:
11+
result = subprocess.run(cmd, shell=True, capture_output=True, text=True, check=True)
12+
print(f"✅ {description} passed")
13+
return True
14+
except subprocess.CalledProcessError as e:
15+
print(f"❌ {description} failed:")
16+
print(f"Error: {e.stderr}")
17+
return False
18+
19+
def check_files_exist():
20+
required_files = [
21+
'smartlogger/__init__.py',
22+
'smartlogger/auto.py',
23+
'setup.py',
24+
'pyproject.toml',
25+
'README.md',
26+
'LICENSE',
27+
'CHANGELOG.md'
28+
]
29+
30+
print("📁 Checking required files...")
31+
missing_files = []
32+
for file in required_files:
33+
if not Path(file).exists():
34+
missing_files.append(file)
35+
36+
if missing_files:
37+
print(f"❌ Missing files: {', '.join(missing_files)}")
38+
return False
39+
else:
40+
print("✅ All required files present")
41+
return True
42+
43+
def main():
44+
print("🧪 SmartLogger Package Validation")
45+
print("=================================")
46+
47+
checks = [
48+
(check_files_exist, "File existence check"),
49+
(lambda: run_command("python -m pytest tests/ -v", "Running tests"), "Unit tests"),
50+
(lambda: run_command("python -c 'import smartlogger.auto; print(\"Import successful\")'", "Testing import"), "Import test"),
51+
(lambda: run_command("python demo_smartlogger.py", "Running demo"), "Demo execution"),
52+
(lambda: run_command("python -m build", "Building package"), "Package build"),
53+
(lambda: run_command("python -m twine check dist/*", "Checking package"), "Package validation"),
54+
]
55+
56+
all_passed = True
57+
58+
for check_func, description in checks:
59+
if not check_func():
60+
all_passed = False
61+
print()
62+
63+
print("\n" + "="*50)
64+
if all_passed:
65+
print("🎉 All checks passed! Package is ready for upload.")
66+
print("\nNext steps:")
67+
print("1. Test upload: ./upload_to_pypi.sh test")
68+
print("2. Production upload: ./upload_to_pypi.sh prod")
69+
else:
70+
print("❌ Some checks failed. Please fix the issues before uploading.")
71+
sys.exit(1)
72+
73+
if __name__ == "__main__":
74+
main()

0 commit comments

Comments
 (0)