Snapshot

Snapshot is a lightweight code snapshotting tool that allows you to save and restore your entire project at any point in time.

Think of it as a simpler alternative to Git when you just want quick save points without branches, commits, remotes, or repositories.

Features

• Save snapshots of your entire project
• Restore previous snapshots at any time
• Ignore files and directories using .snapignore
• View snapshot history
• View detailed snapshot information
• Clean restore mode for exact project restoration
• Rich terminal interface

Installation

From PyPI

pip install snapshot-cli

From source (development)

git clone https://github.com/Sparkleeop/snapshot.git
cd snapshot
pip install -e .

This installs the snap command globally in your environment.

Usage

Initialize Snapshot in your project root:

snap init

Create a snapshot:

snap save "before authentication rewrite"

List all snapshots, you can also find here:

snap list

View information about a snapshot:

snap info <snap id>

Restore a snapshot:

snap restore <snap id>

Perform a clean restore (removes existing project files before restoring):

snap restore <snap id> --clean

Perform a restore to the latest snap:

snap restorelatest <--clean>

Delete a snapshot:

snap del <snap id>

Get the overall project statistics:

snap stats

.snapignore

Use a .snapignore file in your project root to exclude files and directories from snapshots.

Example:

.env
venv
__pycache__
node_modules

Publishing to PyPI

Build and publish:

pip install build twine
python -m build
twine upload dist/*

Roadmap

• Compare snapshots (snap diff <id1> <id2>)
• Snapshot export/import
• Automatic snapshots
• Head snapshot