Skip to main content

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.

Project description

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

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

# 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:
git clone https://github.com/Git32-Design/logrec-and-PYcmd.git
cd logrec-and-PYcmd
  1. From PyPI install:
pip install LogrecAndPYcmd

📁 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
|   |-- __init__.py            # Library initialization and metadata
|   |-- PYcmd log record.log   # PYcmd to record log here 
|   |__ About PYcmd.md         # Detailed PYcmd documentation
|-- LICENSE                    # Project license, using MIT and GPLv3
|-- .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
|-- README.md                  # This repository's README, others are in About
|-- pyproject.toml             # This repository's pyproject.toml, help to publish
|__ .readthedocs.yml           # To publish docs on readthedocs

🔗 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.7.3
  • PYcmd: Release 2.1.1
  • Project Status: Release

Release Status

  • Stable and production-ready
  • Published on PyPI
  • Comprehensive documentation available
  • Tested and verified
  • Continuous integration and testing

🎯 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.8 (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: MIT License

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

🙏 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
  • PyPI Python Package Index: For easy installation of pip

🚀 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 and README.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! 🎉

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

logrecandpycmd-5.8.7.tar.gz (21.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

logrecandpycmd-5.8.7-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

Details for the file logrecandpycmd-5.8.7.tar.gz.

File metadata

  • Download URL: logrecandpycmd-5.8.7.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for logrecandpycmd-5.8.7.tar.gz
Algorithm Hash digest
SHA256 c277d214a8b806cd0742f3e2af71f7999b51032be6966d98977d8ec044c1dbea
MD5 4d56bc39af68960dee24fd8421fc63a4
BLAKE2b-256 7af8a76f3e69c7aaa68b559c683d5de56699ad7b55ab6b95716468aa0235b9bf

See more details on using hashes here.

File details

Details for the file logrecandpycmd-5.8.7-py3-none-any.whl.

File metadata

  • Download URL: logrecandpycmd-5.8.7-py3-none-any.whl
  • Upload date:
  • Size: 20.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for logrecandpycmd-5.8.7-py3-none-any.whl
Algorithm Hash digest
SHA256 bd30c84b03baba8b557c1dd50c4c942670fcd238784806dd933426710aec83d5
MD5 122c3a0ad6a8e6cd0f92a6db1e42c307
BLAKE2b-256 442d7ab7485f2e00e15f251fd2f98df0b8cb740e075b35262f9f2d9f417526fc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page