Skip to content

Commit 2cf9f1f

Browse files
author
Tom Softreck
committed
update
1 parent 02e8eb5 commit 2cf9f1f

25 files changed

+5470
-2
lines changed

.gitignore

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
example.png
2+
example.db
3+
example.txt
4+
.gguf
5+
fixed_script.py
6+
generated_script.py
7+
ollama_raw_response.json
8+
screenshot.png
9+
.pylama
10+
models.json
11+
.idea
12+
venv
13+
models.txt
114
# Byte-compiled / optimized / DLL files
215
__pycache__/
316
*.py[cod]
@@ -128,14 +141,14 @@ celerybeat.pid
128141
*.sage.py
129142

130143
# Environments
131-
.env
144+
#.env
132145
.venv
133146
env/
134147
venv/
135148
ENV/
136149
env.bak/
137150
venv.bak/
138-
151+
poetry.lock
139152
# Spyder project settings
140153
.spyderproject
141154
.spyproject

BADGE.md

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
# Badge Setup Instructions for LogLama
2+
3+
## Quick Setup
4+
5+
1. **Create assets directory** in your repository root:
6+
```bash
7+
mkdir -p assets
8+
```
9+
10+
2. **Save the logo** as `loglama-logo.svg`
11+
12+
3. **Replace the top of your README.md** with the badges section
13+
14+
## Badge Configuration
15+
16+
### Required Actions
17+
18+
Some badges require additional setup to work properly:
19+
20+
#### 1. GitHub Actions CI Badge
21+
Create `.github/workflows/ci.yml`:
22+
23+
```yaml
24+
name: CI
25+
26+
on:
27+
push:
28+
branches: [ main, develop ]
29+
pull_request:
30+
branches: [ main ]
31+
32+
jobs:
33+
test:
34+
runs-on: ubuntu-latest
35+
strategy:
36+
matrix:
37+
python-version: [3.10, 3.11, 3.12]
38+
39+
steps:
40+
- uses: actions/checkout@v4
41+
- name: Set up Python ${{ matrix.python-version }}
42+
uses: actions/setup-python@v4
43+
with:
44+
python-version: ${{ matrix.python-version }}
45+
46+
- name: Install dependencies
47+
run: |
48+
make setup
49+
50+
- name: Run tests
51+
run: |
52+
make test
53+
54+
- name: Run linting
55+
run: |
56+
make lint
57+
```
58+
59+
#### 2. Code Coverage (Codecov)
60+
Add to your CI workflow:
61+
62+
```yaml
63+
- name: Upload coverage to Codecov
64+
uses: codecov/codecov-action@v3
65+
with:
66+
file: ./coverage.xml
67+
flags: unittests
68+
name: codecov-umbrella
69+
```
70+
71+
#### 3. PyPI Badge
72+
Will work automatically once you publish to PyPI with:
73+
```bash
74+
make publish-full
75+
```
76+
77+
### Optional Service Integrations
78+
79+
#### Code Climate
80+
1. Go to [CodeClimate.com](https://codeclimate.com)
81+
2. Add your repository
82+
3. Replace the badge URL with your project's ID
83+
84+
#### SonarCloud
85+
1. Go to [SonarCloud.io](https://sonarcloud.io)
86+
2. Import your GitHub repository
87+
3. Replace the badge URL with your project key
88+
89+
#### Documentation Badge
90+
If you set up documentation hosting:
91+
- **GitHub Pages**: Update URL to your GitHub Pages site
92+
- **Read the Docs**: Update URL to your RTD project
93+
- **Custom docs**: Update URL to your documentation site
94+
95+
## Alternative Badge Variations
96+
97+
### Minimal Badge Set (for new projects)
98+
```markdown
99+
[![PyPI version](https://badge.fury.io/py/loglama.svg)](https://badge.fury.io/py/loglama)
100+
[![Python versions](https://img.shields.io/pypi/pyversions/loglama.svg)](https://pypi.org/project/loglama/)
101+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
102+
[![Build Status](https://github.com/py-lama/loglama/workflows/CI/badge.svg)](https://github.com/py-lama/loglama/actions)
103+
```
104+
105+
### Extended Badge Set (for mature projects)
106+
Add these badges as your project grows:
107+
```markdown
108+
[![Documentation Status](https://readthedocs.org/projects/loglama/badge/?version=latest)](https://loglama.readthedocs.io/en/latest/)
109+
[![Maintainability](https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/maintainability)](https://codeclimate.com/github/py-lama/loglama/maintainability)
110+
[![Test Coverage](https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/test_coverage)](https://codeclimate.com/github/py-lama/loglama/test_coverage)
111+
[![PyPI - Downloads](https://img.shields.io/pypi/dm/loglama)](https://pypi.org/project/loglama/)
112+
```
113+
114+
## Logo Variations
115+
116+
### Horizontal Logo (for headers)
117+
The provided logo is optimized for README headers and documentation.
118+
119+
### Icon Only (for favicons)
120+
Extract just the icon portion:
121+
```svg
122+
<svg viewBox="0 0 70 80" xmlns="http://www.w3.org/2000/svg">
123+
<!-- Extract the document icon and Py symbol from the main logo -->
124+
</svg>
125+
```
126+
127+
### Dark Mode Version
128+
For dark backgrounds, create a version with light colors:
129+
- Change text to white/light gray
130+
- Adjust gradients for better contrast
131+
- Use lighter stroke colors
132+
133+
## Badge Customization
134+
135+
### Color Scheme Matching
136+
All badges use colors that complement the logo:
137+
- **Primary Blue**: `#3b82f6` (matches logo gradient)
138+
- **Success Green**: `#10b981` (matches accent)
139+
- **Warning Yellow**: `#f59e0b`
140+
- **Error Red**: `#ef4444`
141+
142+
### Custom Badges
143+
Create custom badges using [Shields.io](https://shields.io/):
144+
145+
```markdown
146+
![Custom Badge](https://img.shields.io/badge/PyLama-Ecosystem-3b82f6?style=flat&logo=python)
147+
![Status](https://img.shields.io/badge/Status-Active-10b981?style=flat)
148+
![Logging](https://img.shields.io/badge/Logging-Multi--Output-1d4ed8?style=flat)
149+
```
150+
151+
## Maintenance
152+
153+
### Keeping Badges Updated
154+
- **Automated**: Most badges update automatically
155+
- **Manual**: Update version numbers in custom badges when releasing
156+
- **Monitoring**: Regularly check that all badges are working
157+
158+
### Badge Health Check
159+
Periodically verify:
160+
- [ ] All badges load correctly
161+
- [ ] Links point to correct resources
162+
- [ ] No broken or outdated badges
163+
- [ ] Consistent styling across badges
164+
165+
## Troubleshooting
166+
167+
### Common Issues
168+
169+
1. **Badge not updating**: Clear browser cache or check service status
170+
2. **Wrong repository**: Ensure URLs point to correct GitHub repository
171+
3. **Build badge failing**: Check GitHub Actions configuration
172+
4. **Coverage badge missing**: Ensure coverage reports are uploaded
173+
174+
### Badge Service Status
175+
- [Shields.io Status](https://status.shields.io/)
176+
- [GitHub Status](https://www.githubstatus.com/)
177+
- [PyPI Status](https://status.python.org/)

CHANGELOG.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
## [2.0.0] - 2025-05-22
2+
3+
### Added - Major Feature Update
4+
- 🗂️ **File Browser System** - Complete virtual file system with directory navigation
5+
- 🔍 **Process File Preview** - Miniature thumbnails showing actual file content
6+
- 📱 **HTML Rendering at 10% Scale** - Live miniature web page previews for web servers
7+
- 🎯 **Advanced Kill Options** - Kill by PID, service name, port, user with signal selection
8+
- 🔗 **Process Hierarchy Visualization** - Parent-child relationships with visual indicators
9+
- 👁️ **Transparency Layers** - Different opacity levels showing process importance
10+
- 📊 **Enhanced Process Details** - Detailed modals with comprehensive process information
11+
- ⌨️ **Extended Keyboard Shortcuts** - F1 (advanced controls), F2 (file browser)
12+
- 🎨 **Modular Architecture** - Separated CSS, JS, and configuration files
13+
- 📋 **Process Dependencies** - Show what processes depend on what services
14+
- 🌐 **Port Monitoring** - Enhanced port detection and service identification
15+
- 📝 **File Type Recognition** - Smart file type detection with appropriate previews
16+
17+
### Enhanced Features
18+
- **Process Transparency System**:
19+
- Kernel processes: 20% opacity (most transparent)
20+
- System processes: 30% opacity
21+
- Background services: 50% opacity
22+
- User services: 70% opacity
23+
- User applications: 90% opacity (least transparent)
24+
- **File Browser**: Navigate through /bin, /etc, /var, /usr with realistic file content
25+
- **Miniature Previews**:
26+
- Bash scripts shown as terminal text
27+
- HTML files rendered as scaled-down web pages
28+
- Service files displayed with status indicators
29+
- Port services shown with connection info
30+
- **Advanced Filtering**: Search by PID, user, command, service, or port
31+
- **Signal Management**: Choose from SIGTERM, SIGKILL, SIGINT, SIGHUP, SIGUSR1, SIGUSR2
32+
33+
### Technical Improvements
34+
- Split monolithic HTML into separate files:
35+
- `index.html` - Main structure
36+
- `styles.css` - All styling and animations
37+
- `webtop.js` - Main application logic
38+
- `process-data.js` - Process simulation engine
39+
- `file-system.js` - Virtual file system
40+
- `file-icons.css` - File type styling
41+
- `config.json` - Configuration settings
42+
- Responsive design improvements for mobile and tablet
43+
- Enhanced accessibility features
44+
- Performance optimizations for large process lists
45+
46+
### File Structure
47+
```
48+
webtop/static/
49+
├── index.html # Main HTML structure
50+
├── styles.css # Core styling and layout
51+
├── webtop.js # Main application logic
52+
├── process-data.js # Process simulation engine
53+
├── file-system.js # Virtual file system
54+
├── file-icons.css # File type icons and styles
55+
├── config.json # Application configuration
56+
└── manifest.json # Web app manifest
57+
```
58+
59+
### Breaking Changes
60+
- Updated grid layout to accommodate preview column
61+
- New process data structure with hierarchy support
62+
- Modified CSS class names for better organization
63+
64+
## [1.0.0] - 2025-05-22
65+
66+
### Added
67+
- Initial release of WebTop
68+
- Web-based system monitor with htop-inspired interface
69+
- Real-time CPU and memory usage monitoring
70+
- Process list with sorting capabilities
71+
- Basic process termination functionality
72+
- Keyboard shortcuts (F9, F10, Q)
73+
- Interactive process selection
74+
- Terminal-style dark theme with green text
75+
- Auto-updating system statistics
76+
- Command-line interface with customizable host and port
77+
- Cross-platform compatibility
78+
- Zero external dependencies for the web interface
79+
80+
### Features
81+
- 🔄 Real-time monitoring with 2-second update intervals
82+
- 📊 System stats bar showing CPU, memory, load average, and uptime
83+
- 🎯 Interactive process management with click-to-select
84+
- ⌨️ Familiar keyboard shortcuts from htop
85+
- 🎨 Authentic terminal aesthetics
86+
- 📱 Responsive design for various screen sizes
87+
- 🚀 Simple installation and setup
88+
89+
[Unreleased]: https://github.com/devopsterminal/webtop/compare/v2.0.0...HEAD
90+
[2.0.0]: https://github.com/devopsterminal/webtop/releases/tag/v2.0.0
91+
[1.0.0]: https://github.com/devopsterminal/webtop/releases/tag/v1.0.0# Changelog
92+
93+
All notable changes to this project will be documented in this file.
94+
95+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
96+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
97+
98+
## [Unreleased]
99+
100+
## [0.1.0] - 2025-05-22
101+
102+
### Added
103+
- Initial release of WebTop
104+
- Web-based system monitor with htop-inspired interface
105+
- Real-time CPU and memory usage monitoring
106+
- Process list with sorting capabilities
107+
- Process termination functionality
108+
- Keyboard shortcuts (F9, F10, Q)
109+
- Interactive process selection
110+
- Terminal-style dark theme with green text
111+
- Auto-updating system statistics
112+
- Command-line interface with customizable host and port
113+
- Cross-platform compatibility
114+
- Zero external dependencies for the web interface
115+
116+
### Features
117+
- 🔄 Real-time monitoring with 2-second update intervals
118+
- 📊 System stats bar showing CPU, memory, load average, and uptime
119+
- 🎯 Interactive process management with click-to-select
120+
- ⌨️ Familiar keyboard shortcuts from htop
121+
- 🎨 Authentic terminal aesthetics
122+
- 📱 Responsive design for various screen sizes
123+
- 🚀 Simple installation and setup
124+
125+
[Unreleased]: https://github.com/devopsterminal/webtop/compare/v0.1.0...HEAD
126+
[0.1.0]: https://github.com/devopsterminal/webtop/releases/tag/v0.1.0

0 commit comments

Comments
 (0)