Skip to main content

A (very) simple file versioning system

Project description

PyPI Build Status Coverage Status

A (very) simple file versioning system

Version: 1.4.1

Detailed documentation on the available commands can be found on the quicksave wiki

Getting started:

The first thing you’ll need to do is create a new database:

$ quicksave init <path>

That will setup the new database so it’s ready to use.

After that, you’re good to go. You can register new files so they’re tracked by quicksave, save new states of registered files, and revert to previously saved states. There are several other commands which modify the database itself, but I’m only covering those three listed commands in this guide (and none of their various options). For detailed documentation on all of the available commands, check out the wiki page.

To track (AKA register) a new file in quicksave use:

$ quicksave register <filepath>

Which will copy the initial state of the file, and provide the names of the file and state keys you’ll need use this file. For a brief description of file and state keys, see this note on the wiki.

To then save a new state of the file, use the save command:

$ quicksave save <filepath>

Quicksave will use the the absolute path and the base file name derived from filepath to automatically decide which file key to use.

Lastly, to get the file back into a previously saved state, use the revert command:

$ quicksave revert <filepath> <state>

Again, quicksave will attempt to determine which file key to use based on the absolute path and the file name. Quicksave will lookup the provided state key and revert the file.

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

quicksave-1.4.1.tar.gz (16.3 kB view hashes)

Uploaded Source

Built Distribution

quicksave-1.4.1-py3-none-any.whl (17.8 kB view hashes)

Uploaded Python 3

Supported by

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