Zipoc

Zipoc is a lightweight, fully-local version control system designed for any project. It enables users to initialize a repository, create commits from their working directory, and review them through a convenient terminal interface or a simple web UI.

Key Features

• Easily initialize a project repository in a dedicated .zipoc/ directory.
• Create commits that snapshot your project files, capturing the state of development.
• Safely delete the repository when no longer needed.
• View and navigate through commits using a Flask-powered web interface.

Current Development Goals

• Implement a terminal-based user interface for viewing commits.
• Allow users to export specific versions from commit hashes in .zip format.
• Enable restoration of files from a commit back into the working directory.

Getting Started with Zipoc

Zipoc can be installed directly via pip, offering a straightforward command-line interface for operation. Use zipoc <command> to access the functionalities:

Initializing a Repository

Create a new repository and configure project metadata with:

zipoc init

Users will be prompted to input the project name and an optional description.

Making a Commit

To record changes in the project, create a commit with:

zipoc commit

This command generates a new commit under .zipoc/commits/<hash>/, storing metadata along with a snapshot of the project files, while excluding common folders like .git, __pycache__, and virtual environments.

Viewing Commits

Access the viewer to explore commits using:

zipoc view --web  # For Web UI
zipoc view --terminal  # For Terminal UI

This provides a straightforward way to check the project history and commit details.

Deleting a Repository

To remove all tracked data and the associated .zipoc/ folder, execute:

zipoc delete

Note that this action is irreversible.

Why Choose Zipoc Over Git?

While Git is a robust version control system, there are scenarios where Zipoc is more suitable:

• For projects that only require local history without the complexity of remotes, branches, or rebases.
• For educators introducing version control concepts to beginners without overwhelming them with Git's intricacies.
• When a quick, disposable snapshot of the project is needed for experimentation or prototyping.

Zipoc simplifies version control, making it accessible and efficient for developers seeking straightforward functionality.