simple-vcs 1.0.0__tar.gz → 1.2.0__tar.gz

simple_vcs-1.2.0/PKG-INFO

@@ -0,0 +1,352 @@
+Metadata-Version: 2.4
+Name: simple-vcs
+Version: 1.2.0
+Summary: A beautiful and simple version control system with a modern terminal interface
+Home-page: https://github.com/muhammadsufiyanbaig/simple_vcs
+Author: Muhammad Sufiyan Baig
+Author-email: Muhammad Sufiyan Baig <send.sufiyan@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2024 SimpleVCS
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Homepage, https://github.com/muhammadsufiyanbaig/simple_vcs/
+Project-URL: Repository, https://github.com/muhammadsufiyanbaig/simple_vcs.git
+Project-URL: Issues, https://github.com/muhammadsufiyanbaig/simple_vcs/issues
+Keywords: version-control,vcs,simple-vcs,backup,snapshot
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=7.0
+Requires-Dist: rich>=10.0.0
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# SimpleVCS
+
+A simple version control system written in Python that provides basic VCS functionality similar to Git - now with a **beautiful modern terminal interface**!
+
+## ✨ New in Version 1.2.0
+
+**Stunning Visual Interface** - SimpleVCS now features a gorgeous terminal interface powered by Rich:
+- 🎨 **Colored Output** - Color-coded messages for success, warnings, and errors
+- 📊 **Beautiful Tables** - Commit history and status displayed in elegant tables
+- 📦 **Styled Panels** - Information presented in clean, bordered boxes
+- 🌟 **Professional Look** - Modern, easy-to-read formatting throughout
+
+## Features
+
+- Initialize repositories
+- Add files to staging area
+- Commit changes with messages or timestamps
+- View commit history with detailed information
+- Show differences between commits
+- Repository status tracking
+- Cross-platform compatibility
+- Both CLI and Python API support
+- Quick revert to any previous commit
+- Create and restore from snapshots
+- Automatic object compression to save space
+- Simplified workflow compared to Git
+
+## Installation
+
+### From PyPI (when published)
+```bash
+pip install simple-vcs
+```
+
+### From Source
+```bash
+# Clone the repository
+git clone https://github.com/muhammadsufiyanbaig/simple_vcs.git
+cd simple_vcs
+
+# Install in development mode
+pip install -e .
+
+# Or install normally
+pip install .
+```
+
+## Quick Start
+
+```bash
+# Initialize a new repository
+svcs init
+
+# Create a sample file
+echo "Hello World" > hello.txt
+
+# Add file to staging area
+svcs add hello.txt
+
+# Commit the changes
+svcs commit -m "Add hello.txt"
+
+# View commit history
+svcs log
+```
+
+## Usage
+
+### Command Line Interface
+
+#### Repository Management
+```bash
+# Initialize a new repository in current directory
+svcs init
+
+# Initialize in specific directory
+svcs init --path /path/to/project
+```
+
+#### File Operations
+```bash
+# Add single file
+svcs add filename.txt
+
+# Add multiple files
+svcs add file1.txt file2.py file3.md
+
+# Check repository status
+svcs status
+```
+
+#### Commit Operations
+```bash
+# Commit with message
+svcs commit -m "Your commit message"
+
+# Commit with auto-generated timestamp
+svcs commit
+
+# View commit history
+svcs log
+
+# View limited commit history
+svcs log --limit 5
+```
+
+#### Viewing Differences
+```bash
+# Show diff between last two commits
+svcs diff
+
+# Show diff between specific commits
+svcs diff --c1 1 --c2 3
+
+# Show diff between commit 2 and latest
+svcs diff --c1 2
+```
+
+#### Advanced Operations
+```bash
+# Quickly revert to a specific commit
+svcs revert 3
+
+# Create a snapshot of current state
+svcs snapshot
+
+# Create a named snapshot
+svcs snapshot --name my_backup
+
+# Restore from a snapshot
+svcs restore path/to/snapshot.zip
+
+# Compress stored objects to save space
+svcs compress
+```
+
+### Python API
+
+```python
+from simple_vcs import SimpleVCS
+
+# Create VCS instance
+vcs = SimpleVCS("./my_project")
+
+# Initialize repository
+vcs.init_repo()
+
+# Add files
+vcs.add_file("example.txt")
+vcs.add_file("script.py")
+
+# Commit changes
+vcs.commit("Initial commit with example files")
+
+# Show commit history
+vcs.show_log()
+
+# Show differences between commits
+vcs.show_diff(1, 2)
+
+# Check repository status
+vcs.status()
+
+# Quick revert to a specific commit
+vcs.quick_revert(2)
+
+# Create a snapshot of current state
+vcs.create_snapshot()
+vcs.create_snapshot("my_backup")
+
+# Restore from a snapshot
+vcs.restore_from_snapshot("my_backup.zip")
+
+# Compress stored objects to save space
+vcs.compress_objects()
+```
+
+## Advanced Usage
+
+### Working with Multiple Files
+```python
+from simple_vcs import SimpleVCS
+from simple_vcs.utils import get_all_files
+
+vcs = SimpleVCS()
+vcs.init_repo()
+
+# Add all Python files in current directory
+python_files = [f for f in get_all_files(".") if f.endswith('.py')]
+for file in python_files:
+    vcs.add_file(file)
+
+vcs.commit("Add all Python files")
+```
+
+### Repository Structure
+When initialized, SimpleVCS creates a `.svcs` directory containing:
+```
+.svcs/
+├── objects/          # File content storage (hashed)
+├── commits.json      # Commit history and metadata
+├── staging.json      # Currently staged files
+└── HEAD             # Current commit reference
+```
+
+## Requirements
+
+- Python 3.7 or higher
+- click>=7.0 (for CLI functionality)
+- rich>=10.0.0 (for beautiful terminal interface)
+
+## Development
+
+### Setting up Development Environment
+```bash
+# Clone the repository
+git clone https://github.com/muhammadsufiyanbaig/simple_vcs.git
+cd simple_vcs
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install in development mode
+pip install -e .
+
+# Install development dependencies
+pip install pytest pytest-cov black flake8
+```
+
+### Running Tests
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=simple_vcs
+
+# Run specific test file
+pytest tests/test_core.py
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Make your changes
+4. Add tests for your changes
+5. Ensure tests pass (`pytest`)
+6. Commit your changes (`git commit -m 'Add amazing feature'`)
+7. Push to the branch (`git push origin feature/amazing-feature`)
+8. Open a Pull Request
+
+## Publishing to PyPI
+
+```bash
+# Install build tools
+pip install build twine
+
+# Build the package
+python -m build
+
+# Upload to PyPI (requires PyPI account)
+twine upload dist/*
+```
+
+## Limitations
+
+This is a simple implementation for educational purposes. It lacks advanced features like:
+- Branching and merging
+- Remote repositories
+- File conflict resolution
+- Large file handling
+- Advanced diff algorithms
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Author
+
+Muhammad Sufiyan Baig - send.sufiyan@gmail.com
+
+Project Link: [https://github.com/muhammadsufiyanbaig/simple_vcs](https://github.com/muhammadsufiyanbaig/simple_vcs)
+
+## Changelog
+
+### Version 1.2.0
+- **Beautiful Terminal Interface**: Complete visual overhaul with Rich library
+- **Colored Output**: Green for success, yellow for warnings, red for errors
+- **Elegant Tables**: Commit history, status, and diffs in formatted tables
+- **Styled Panels**: Information displayed in bordered panels with rounded corners
+- **Enhanced Commands**: All commands now have beautiful, professional output
+- **Better UX**: Clear visual hierarchy and consistent formatting
+- **Windows Compatible**: No problematic Unicode characters
+- **Enhanced Help**: Detailed descriptions and examples for all commands
+
+### Version 1.1.0
+- Added quick revert functionality to go back to any commit instantly
+- Added snapshot creation and restoration features
+- Added automatic object compression to save disk space
+- Improved CLI with new commands (revert, snapshot, restore, compress)
+- Enhanced documentation and examples
+- Fixed CLI entry point issue for direct terminal usage
+
+### Version 1.0.0
+- Initial release
+- Basic VCS functionality (init, add, commit, log, diff, status)
+- CLI and Python API support
+- Cross-platform compatibility