Skip to content
Snippets Groups Projects
Unverified Commit 459968ae authored by Frank Sauerburger's avatar Frank Sauerburger
Browse files

Explain initial idea

Add a readme file which outlines the initial idea of c-shelve and its use case.
parents
Branches setup_ci
No related tags found
Loading
This repository is still in the R&D stage.
# What is c-shelve?
`c-shelve` is a command line tool, which can be used to *C*onvert python
*shelve* archives to use a different backend. Python provides the shelve package to store python object in
a key-value store, which behaves like a `dict`. Shelve can be used with three different
backends which mange the archive: `dbm.gdbm`, `dbm.ndbm` or `dbm.dumb`.
By default, shelve uses `dbm.gdbm`, which is platform dependent. A shelve
archive created on a `32bit` system can not be opened on a `64bit` system, or
the other way round, [stackoverflow
post](https://stackoverflow.com/questions/22645231/shelve-archives-not-openable-on-other-computer).
`c-shelve` is intended to help in this case by converting shelve files to a different
backend which is platform independent.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment