simple-vcs 1.0.0__py3-none-any.whl

simple_vcs/__init__.py

@@ -0,0 +1,10 @@
+"""
+SimpleVCS - A simple version control system
+"""
+
+__version__ = "1.0.0"
+__author__ = "Your Name"
+
+from .core import SimpleVCS
+
+__all__ = ["SimpleVCS"]

simple_vcs/cli.py

@@ -0,0 +1,54 @@
+import click
+from .core import SimpleVCS
+
+@click.group()
+@click.version_option()
+def main():
+    """SimpleVCS - A simple version control system"""
+    pass
+
+@main.command()
+@click.option('--path', default='.', help='Repository path')
+def init(path):
+    """Initialize a new repository"""
+    vcs = SimpleVCS(path)
+    vcs.init_repo()
+
+@main.command()
+@click.argument('files', nargs=-1, required=True)
+def add(files):
+    """Add files to staging area"""
+    vcs = SimpleVCS()
+    for file in files:
+        vcs.add_file(file)
+
+@main.command()
+@click.option('-m', '--message', help='Commit message')
+def commit(message):
+    """Commit staged changes"""
+    vcs = SimpleVCS()
+    vcs.commit(message)
+
+@main.command()
+@click.option('--c1', type=int, help='First commit ID')
+@click.option('--c2', type=int, help='Second commit ID')
+def diff(c1, c2):
+    """Show differences between commits"""
+    vcs = SimpleVCS()
+    vcs.show_diff(c1, c2)
+
+@main.command()
+@click.option('--limit', type=int, help='Limit number of commits to show')
+def log(limit):
+    """Show commit history"""
+    vcs = SimpleVCS()
+    vcs.show_log(limit)
+
+@main.command()
+def status():
+    """Show repository status"""
+    vcs = SimpleVCS()
+    vcs.status()
+
+if __name__ == '__main__':
+    main()

simple_vcs/core.py

@@ -0,0 +1,276 @@
+import os
+import json
+import hashlib
+import shutil
+import time
+from datetime import datetime
+from pathlib import Path
+from typing import Dict, List, Optional, Tuple
+
+class SimpleVCS:
+    """Simple Version Control System core functionality"""
+    
+    def __init__(self, repo_path: str = "."):
+        self.repo_path = Path(repo_path).resolve()
+        self.svcs_dir = self.repo_path / ".svcs"
+        self.objects_dir = self.svcs_dir / "objects"
+        self.commits_file = self.svcs_dir / "commits.json"
+        self.staging_file = self.svcs_dir / "staging.json"
+        self.head_file = self.svcs_dir / "HEAD"
+        
+    def init_repo(self) -> bool:
+        """Initialize a new repository"""
+        if self.svcs_dir.exists():
+            print(f"Repository already exists at {self.repo_path}")
+            return False
+            
+        # Create directory structure
+        self.svcs_dir.mkdir()
+        self.objects_dir.mkdir()
+        
+        # Initialize files
+        self._write_json(self.commits_file, [])
+        self._write_json(self.staging_file, {})
+        self.head_file.write_text("0")  # Start with commit 0
+        
+        print(f"Initialized empty SimpleVCS repository at {self.repo_path}")
+        return True
+    
+    def add_file(self, file_path: str) -> bool:
+        """Add a file to staging area"""
+        if not self._check_repo():
+            return False
+            
+        file_path = Path(file_path).resolve()  # Convert to absolute path
+        if not file_path.exists():
+            print(f"File {file_path} does not exist")
+            return False
+            
+        if not file_path.is_file():
+            print(f"{file_path} is not a file")
+            return False
+            
+        # Check if file is within repository
+        try:
+            relative_path = file_path.relative_to(self.repo_path)
+        except ValueError:
+            print(f"File {file_path} is not within the repository")
+            return False
+            
+        # Calculate file hash
+        file_hash = self._calculate_file_hash(file_path)
+        
+        # Store file content in objects
+        self._store_object(file_hash, file_path.read_bytes())
+        
+        # Add to staging
+        staging = self._read_json(self.staging_file)
+        staging[str(relative_path)] = {
+            "hash": file_hash,
+            "size": file_path.stat().st_size,
+            "modified": file_path.stat().st_mtime
+        }
+        self._write_json(self.staging_file, staging)
+        
+        print(f"Added {file_path.name} to staging area")
+        return True
+    
+    def commit(self, message: Optional[str] = None) -> bool:
+        """Commit staged changes"""
+        if not self._check_repo():
+            return False
+            
+        staging = self._read_json(self.staging_file)
+        if not staging:
+            print("No changes to commit")
+            return False
+            
+        # Create commit object
+        commit = {
+            "id": len(self._read_json(self.commits_file)) + 1,
+            "message": message or f"Commit at {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}",
+            "timestamp": time.time(),
+            "files": staging.copy(),
+            "parent": self._get_current_commit_id()
+        }
+        
+        # Save commit
+        commits = self._read_json(self.commits_file)
+        commits.append(commit)
+        self._write_json(self.commits_file, commits)
+        
+        # Update HEAD
+        self.head_file.write_text(str(commit["id"]))
+        
+        # Clear staging
+        self._write_json(self.staging_file, {})
+        
+        print(f"Committed changes with ID: {commit['id']}")
+        print(f"Message: {commit['message']}")
+        return True
+    
+    def show_diff(self, commit_id1: Optional[int] = None, commit_id2: Optional[int] = None) -> bool:
+        """Show differences between commits"""
+        if not self._check_repo():
+            return False
+            
+        commits = self._read_json(self.commits_file)
+        if not commits:
+            print("No commits found")
+            return False
+            
+        # Default to comparing last two commits
+        if commit_id1 is None and commit_id2 is None:
+            if len(commits) < 2:
+                print("Need at least 2 commits to show diff")
+                return False
+            commit1 = commits[-2]
+            commit2 = commits[-1]
+        else:
+            commit1 = self._get_commit_by_id(commit_id1 or (len(commits) - 1))
+            commit2 = self._get_commit_by_id(commit_id2 or len(commits))
+            
+        if not commit1 or not commit2:
+            print("Invalid commit IDs")
+            return False
+            
+        print(f"\nDifferences between commit {commit1['id']} and {commit2['id']}:")
+        print("-" * 50)
+        
+        files1 = set(commit1["files"].keys())
+        files2 = set(commit2["files"].keys())
+        
+        # New files
+        new_files = files2 - files1
+        if new_files:
+            print("New files:")
+            for file in new_files:
+                print(f"  + {file}")
+        
+        # Deleted files
+        deleted_files = files1 - files2
+        if deleted_files:
+            print("Deleted files:")
+            for file in deleted_files:
+                print(f"  - {file}")
+        
+        # Modified files
+        common_files = files1 & files2
+        modified_files = []
+        for file in common_files:
+            if commit1["files"][file]["hash"] != commit2["files"][file]["hash"]:
+                modified_files.append(file)
+        
+        if modified_files:
+            print("Modified files:")
+            for file in modified_files:
+                print(f"  M {file}")
+        
+        if not new_files and not deleted_files and not modified_files:
+            print("No differences found")
+            
+        return True
+    
+    def show_log(self, limit: Optional[int] = None) -> bool:
+        """Show commit history"""
+        if not self._check_repo():
+            return False
+            
+        commits = self._read_json(self.commits_file)
+        if not commits:
+            print("No commits found")
+            return False
+            
+        commits_to_show = commits[-limit:] if limit else commits
+        commits_to_show.reverse()  # Show newest first
+        
+        print("\nCommit History:")
+        print("=" * 50)
+        
+        for commit in commits_to_show:
+            print(f"Commit ID: {commit['id']}")
+            print(f"Date: {datetime.fromtimestamp(commit['timestamp']).strftime('%Y-%m-%d %H:%M:%S')}")
+            print(f"Message: {commit['message']}")
+            print(f"Files: {len(commit['files'])} file(s)")
+            if commit.get('parent'):
+                print(f"Parent: {commit['parent']}")
+            print("-" * 30)
+            
+        return True
+    
+    def status(self) -> bool:
+        """Show repository status"""
+        if not self._check_repo():
+            return False
+            
+        staging = self._read_json(self.staging_file)
+        current_commit = self._get_current_commit()
+        
+        print(f"\nRepository: {self.repo_path}")
+        print(f"Current commit: {current_commit['id'] if current_commit else 'None'}")
+        
+        if staging:
+            print("\nStaged files:")
+            for file, info in staging.items():
+                print(f"  {file}")
+        else:
+            print("\nNo files staged")
+            
+        return True
+    
+    # Helper methods
+    def _check_repo(self) -> bool:
+        """Check if repository is initialized"""
+        if not self.svcs_dir.exists():
+            print("Not a SimpleVCS repository. Run 'svcs init' first.")
+            return False
+        return True
+    
+    def _calculate_file_hash(self, file_path: Path) -> str:
+        """Calculate SHA-256 hash of file"""
+        hasher = hashlib.sha256()
+        with open(file_path, 'rb') as f:
+            for chunk in iter(lambda: f.read(4096), b""):
+                hasher.update(chunk)
+        return hasher.hexdigest()
+    
+    def _store_object(self, obj_hash: str, content: bytes):
+        """Store object in objects directory"""
+        obj_path = self.objects_dir / obj_hash
+        if not obj_path.exists():
+            obj_path.write_bytes(content)
+    
+    def _read_json(self, file_path: Path) -> Dict:
+        """Read JSON file"""
+        if not file_path.exists():
+            return {}
+        return json.loads(file_path.read_text())
+    
+    def _write_json(self, file_path: Path, data: Dict):
+        """Write JSON file"""
+        file_path.write_text(json.dumps(data, indent=2))
+    
+    def _get_current_commit_id(self) -> Optional[int]:
+        """Get current commit ID"""
+        if not self.head_file.exists():
+            return None
+        try:
+            commit_id = int(self.head_file.read_text().strip())
+            return commit_id if commit_id > 0 else None
+        except:
+            return None
+    
+    def _get_current_commit(self) -> Optional[Dict]:
+        """Get current commit object"""
+        commit_id = self._get_current_commit_id()
+        if not commit_id:
+            return None
+        return self._get_commit_by_id(commit_id)
+    
+    def _get_commit_by_id(self, commit_id: int) -> Optional[Dict]:
+        """Get commit by ID"""
+        commits = self._read_json(self.commits_file)
+        for commit in commits:
+            if commit["id"] == commit_id:
+                return commit
+        return None

simple_vcs/utils.py

@@ -0,0 +1,36 @@
+import os
+from pathlib import Path
+from typing import List
+
+def get_all_files(directory: str, ignore_patterns: List[str] = None) -> List[str]:
+    """Get all files in directory, excluding ignored patterns"""
+    if ignore_patterns is None:
+        ignore_patterns = ['.svcs', '__pycache__', '.git', '.DS_Store']
+    
+    files = []
+    for root, dirs, filenames in os.walk(directory):
+        # Remove ignored directories
+        dirs[:] = [d for d in dirs if not any(pattern in d for pattern in ignore_patterns)]
+        
+        for filename in filenames:
+            # Skip ignored files
+            if any(pattern in filename for pattern in ignore_patterns):
+                continue
+                
+            file_path = os.path.join(root, filename)
+            files.append(file_path)
+    
+    return files
+
+def format_file_size(size_bytes: int) -> str:
+    """Format file size in human readable format"""
+    if size_bytes == 0:
+        return "0B"
+    
+    size_names = ["B", "KB", "MB", "GB"]
+    i = 0
+    while size_bytes >= 1024 and i < len(size_names) - 1:
+        size_bytes /= 1024.0
+        i += 1
+    
+    return f"{size_bytes:.1f}{size_names[i]}"

simple_vcs-1.0.0.dist-info/METADATA

@@ -0,0 +1,278 @@
+Metadata-Version: 2.4
+Name: simple-vcs
+Version: 1.0.0
+Summary: A simple version control system written in Python
+Home-page: https://github.com/yourusername/simple-vcs
+Author: Your Name
+Author-email: your.email@example.com
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=7.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# README.md
+# SimpleVCS
+
+A simple version control system written in Python that provides basic VCS functionality similar to Git.
+
+## 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
+
+## 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
+```
+
+### 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()
+```
+
+## 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)
+
+## Development
+
+### Setting up Development Environment
+```bash
+# Clone the repository
+git clone https://github.com/yourusername/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
+
+Your Name - your.email@example.com
+
+## Changelog
+
+### Version 1.0.0
+- Initial release
+- Basic VCS functionality (init, add, commit, log, diff, status)
+- CLI and Python API support
+- Cross-platform compatibility

simple_vcs-1.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+simple_vcs/__init__.py,sha256=ic-WO0wttRy6ILvZL1GdR0icHUmNNSoL6fvPjKG00tE,164
+simple_vcs/cli.py,sha256=YZCzSozCNNZGwVdER121cPhpLhJ6miCiSOiqYcfz664,1314
+simple_vcs/core.py,sha256=q4FF7s6y0PRU7cMfq9E32wMsR-jrHBo_8m5qj5heRnM,9771
+simple_vcs/utils.py,sha256=CTd4gDdHqP-dawjtEeKU3csnT-Fe7_SN9a5ENQlo7wk,1202
+simple_vcs-1.0.0.dist-info/licenses/LICENSE,sha256=6o_m1QgCywYf-QZnE6cuLTwu5kVVQn3vJ7JJUd0V_iY,1085
+simple_vcs-1.0.0.dist-info/METADATA,sha256=5tmnxoOajcwq4kXaAbunr1nGrXfjoPRn5V_sZnCN8Ws,5908
+simple_vcs-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+simple_vcs-1.0.0.dist-info/entry_points.txt,sha256=19JeWUvRFzwKF5p_iLQiSwCV3XTgxB7mkTLmFGrc_aY,45
+simple_vcs-1.0.0.dist-info/top_level.txt,sha256=YcaiuqQjjXFL-H62tfC-hTcg-7sWFmLh65zghskauL4,11
+simple_vcs-1.0.0.dist-info/RECORD,,

simple_vcs-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

simple_vcs-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+svcs = simple_vcs.cli:main

simple_vcs-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+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.

simple_vcs-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+simple_vcs