Metadata-Version: 2.4
Name: LogrecAndPYcmd
Version: 3.7.3
Summary: logrec: A quick record log's lib, Can search log file, And record(Or write) logs to a file. It's easy, Please use "logging" library. I know, My lib is sucks, But I well publish it to github. PYcmd: This program is a command prompt tool for managing files.
Author-email: Git32-Design <git32mail@qq.com>
License-Expression: MIT AND (Apache-2.0 OR BSD-3-Clause)
Project-URL: Homepage, https://github.com/Git32-Design/logrec-and-PYcmd
Project-URL: Documentation, https://readthedocs.org
Project-URL: Repository, https://github.com/Git32-Design/logrec-and-PYcmd
Project-URL: Issues, https://github.com/Git32-Design/logrec-and-PYcmd/issues
Project-URL: Changelog, https://github.com/Git32-Design/logrec-and-PYcmd/blob/main/Update%20msgs.md
Project-URL: MyHomepage, https://github.com/Git32-Design
Project-URL: DOWNLOAD, https://github.com/Git32-Design/logrec-and-PYcmd/releases
Keywords: log,logger,recording,search,management,file,logging,debug,custom cmd
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Logging
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pytest>=7.0
Provides-Extra: test
Requires-Dist: pytest>=7.0; extra == "test"
Dynamic: license-file

# logrec and PYcmd

Welcome to the logrec and PYcmd project repository! This repository contains two complementary Python tools designed to enhance your development and file management experience.

## 📦 What's Included

### 📝 logrec - Log Recorder Library
A simple yet powerful Python library for recording and managing logs with search capabilities.

**Key Features:**
- Simple & intuitive API design
- Multiple log levels (INFO, TIP, WARN, ERROR, CRITICAL)
- File management (read, search, delete, modify, clear)
- Automatic timestamps
- Lightweight with no external dependencies
- Object-oriented LogRecorder class

**Perfect for:**
- Application logging
- Debugging sessions
- Quick record keeping
- Learning logging concepts

### 🖥️ PYcmd - Python Command Tool
A powerful command-line tool for file management, calculations, and system operations with integrated logging.

**Key Features:**
- Complete file management suite
- Directory operations
- Mathematical calculations
- Random number generation
- Time and date utilities
- Interactive command interface
- Integrated logging with logrec

**Perfect for:**
- System administration tasks
- File batch operations
- Quick calculations
- Learning command-line tool development

## 🚀 Quick Start

### Using logrec

```python
import logrec

# Simple logging
logrec.log("app.log", "Application started")
logrec.err("app.log", "Error occurred")

# Using the LogRecorder class
logger = LogRecorder("myapp.log")
logger.log("User logged in")
logger.warn("Session expiring soon")
```

### Using PYcmd

```bash
# Run the interactive command interface
python PYcmd.py

# Available commands include:
# read, write, create, delete, listdir, copy, rename
# mkdir, rmdir, cd, pwd, compare, stats
# math, calc, rand, showt, help, clear, exit
```

## 🛠️ Installation & Setup

### Prerequisites
- Python 3.10 or higher
- Standard Python libraries (os, math, random, time, pathlib)

### Installation Steps

1. **Clone this repository:**
```bash
git clone https://github.com/Git32-Design/logrec-and-PYcmd.git
cd logrec-and-PYcmd
```

2. **Install logrec library (optional):**
```python
# Option 1: Install to site-packages
# Copy logrec folder to your Python site-packages directory

# Option 2: Use directly
# Import logrec from the local directory
import sys
sys.path.append('/path/to/logrec-and-PYcmd')
import logrec
```

3. **Run PYcmd:**
```bash
python PYcmd/PYcmd.py
```

## 📁 Repository Structure

```
logrec-and-PYcmd/              # Main repository folder
|-- .github/                   # Github settings
|   |-- workflows/             # To publish package
|   |   |-- python-package.yml # A setting of publish
|   |   |__ python-publish.yml # Publish messages
|-- logrec/                    # Log Recorder Library
|   |-- tests/                 # Test of logrec
|   |   |-- test_logrec.py     # Test script
|   |   |-- c.log              # Test logs
|   |   |-- g.log              # Test logs
|   |   |-- s.log              # Test logs
|   |   |__ t.log              # Test logs
|   |-- __init__.py            # Library initialization and metadata
|   |-- logrec.py              # Core logging functionality
│   |__ About logrec.md        # Detailed logrec documentation
|-- PYcmd/                     # Python Command Tool
|   |-- tests/                 # Tests of PYcmd
|   |   |__ test-PYcmd         # Test script
│   |-- PYcmd.py               # Main command tool implementation
|   |__ About PYcmd.md         # Detailed PYcmd documentation
|-- LICENSE                    # Project license
|-- .gitignore                 # Git ignore rules
|-- About logrec and PYcmd.md  # This file - project overview
|-- requirements.txt           # This repository's requirement modules
|__ Update msgs.md             # This repository every update informations
```

## 🔗 Integration

### logrec + PYcmd Integration
PYcmd uses logrec internally for all operation logging:
- Successful operations are logged as normal entries
- Errors are logged with detailed error information
- Logs are saved to `PYcmd log record.log`
- Provides complete audit trail of all operations

## 📋 Version Information

### Current Versions
- **logrec**: Release 3.3.2
- **PYcmd**: Dev Alpha 1.0.0
- **Project Status**: Development

### Development Status
Both tools are currently in alpha development phase:
- ✅ Core functionality implemented
- ✅ Basic testing completed
- 🔄 Feature development ongoing
- 📋 Documentation in progress
- 🐛 Bug fixes and improvements

## 🎯 Use Cases

### For Developers
- **Application Logging**: Use logrec in your Python applications
- **Development Tools**: Use PYcmd for quick file operations
- **Learning Resources**: Study the code to understand Python concepts
- **Script Development**: Extend or modify for custom needs

### For System Administrators
- **File Management**: Use PYcmd for batch file operations
- **Log Analysis**: Use logrec for custom logging solutions
- **Automation**: Integrate into existing workflows
- **Quick Tasks**: Use PYcmd's interactive interface

### For Students
- **Learning Python**: Study well-commented code examples
- **Understanding File I/O**: Learn practical file operations
- **API Design**: Study clean function interfaces
- **Project Structure**: Learn repository organization

## 🔧 Technical Specifications

### Dependencies
- **logrec**: Python standard library only (os, time)
- **PYcmd**: Python standard library (os, math, random, time, pathlib) + logrec

### Compatibility
- **Python**: 3.10+ (recommended 3.13)
- **Operating System**: Cross-platform (Windows, Linux, macOS)
- **Memory Usage**: Lightweight, minimal footprint

### Performance
- **Logging Speed**: Fast file I/O with minimal overhead
- **Command Response**: Quick execution for most operations
- **Resource Usage**: Low CPU and memory requirements

## 📄 Licensing

This project uses dual licensing:
- **logrec**: MIT License
- **PYcmd**: GNU General Public License v3.0

See individual LICENSE files for details.

## 🤝 Contributing

We welcome contributions! Here's how you can help:

### Reporting Issues
- Use GitHub Issues for bug reports
- Provide detailed reproduction steps
- Include system information
- Add screenshots if applicable

### Submitting Pull Requests
- Fork the repository
- Create a feature branch
- Make your changes
- Test thoroughly
- Submit pull request with description

### Code Standards
- Follow PEP 8 guidelines
- Add comments to complex code
- Update documentation
- Include tests when possible

## 📞 Contact Information

- Author: Git32-Design
- Developer page : [User stats page](https://github.com/Git32-Design)
- Email: git32mail@qq.com
- Steam : Git32-Games *In steam, You can call me "Git32Play"*
- Netease minecraft : Git32Design__ *I haven't money to buy release, But netease make me happy, You can call me "git32mc"*
- Project URL: [Into main page for see updates](https://github.com/Git32-Design/logrec-and-PYcmd)

## 🙏 Acknowledgments

### Development Tools
- **Visual Studio Code**: Primary development environment
- **CODEBUDDY**: AI coding assistant
- **Python Extension Pack**: Python language support
- **Pylance**: Python linting and intelligence

### Community
- **Python Community**: For excellent documentation and examples
- **GitHub Community**: For hosting and collaboration tools
- **Open Source Contributors**: For inspiration and best practices

## 🚀 Roadmap

### Upcoming Features
- [ ] Enhanced error handling in PYcmd
- [ ] Configuration file support
- [ ] Plugin system for PYcmd
- [ ] Advanced search capabilities in logrec
- [ ] Performance optimizations
- [ ] Additional file format support

### Long-term Goals
- [ ] GUI interface for PYcmd
- [ ] Web interface for log management
- [ ] Integration with popular frameworks
- [ ] Comprehensive test suite
- [ ] Internationalization support
- [ ] Package distribution (PyPI)

---

## 💡 Getting Help

### Documentation
- Read the individual `About*.md` files for detailed information
- Check code comments for implementation details
- Review function docstrings for usage examples

### Community Support
- GitHub Issues for bug reports and feature requests
- Discussions for general questions and ideas
- Pull Requests for contributions

### Learning Resources
- Python official documentation
- File I/O tutorials
- Command-line tool development guides
- Logging best practices

---

**Thank you for using logrec and PYcmd!** 

We're constantly working to improve these tools and would love to hear your feedback, suggestions, and ideas. Whether you're a developer, system administrator, or student, we hope these tools make your work easier and more productive.

Happy coding! 🎉
