Rename to minimalkv

data-engineering-collective · Apr 2, 2021 · 8bfefb7 · 8bfefb7
1 parent c90117e
commit 8bfefb7
Show file tree

Hide file tree

Showing 64 changed files with 223 additions and 327 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -13,9 +13,9 @@ jobs:
       postgres:
         image: postgres:11
         env:
-          POSTGRES_DB: simplekv_test
-          POSTGRES_PASSWORD: simplekv_test
-          POSTGRES_USER: simplekv_test
+          POSTGRES_DB: minimalkv_test
+          POSTGRES_PASSWORD: minimalkv_test
+          POSTGRES_USER: minimalkv_test
     env:
       SIMPLEKV_CI: 1
     steps:

diff --git a/.travis.yml b/.travis.yml
diff --git a/README.rst b/README.rst
@@ -1,33 +1,28 @@
-simple key-value storage api
-============================
+minimal key-value storage api
+=============================
 
-.. image:: https://travis-ci.org/mbr/simplekv.png?branch=master
-   :target: https://travis-ci.org/mbr/simplekv
-.. image:: https://coveralls.io/repos/github/mbr/simplekv/badge.svg?branch=master
-   :target: https://coveralls.io/github/mbr/simplekv?branch=master
-
-*simplekv* is an API for very basic key-value stores used for small, frequently
+*minimalkv* is an API for very basic key-value stores used for small, frequently
 accessed data or large binary blobs. Its basic interface is easy to implement
 and it supports a number of backends, including the filesystem, SQLAlchemy,
 MongoDB, Redis and Amazon S3/Google Storage.
 
 Installation
 ------------
-simplekv is `available on PyPI <http://pypi.python.org/pypi/simplekv/>`_ and
+minimalkv is `available on PyPI <http://pypi.python.org/pypi/minimalkv/>`_ and
 can be installed through `pip <http://pypi.python.org/pypi/pip>`_::
 
-   pip install simplekv
+   pip install minimalkv
    
-or via ``conda`` on `conda-forge <https://github.com/conda-forge/simplekv-feedstock>`_::
+or via ``conda`` on `conda-forge <https://github.com/conda-forge/minimalkv-feedstock>`_::
 
-  conda install -c conda-forge simplekv
+  conda install -c conda-forge minimalkv
 
 Documentation
 -------------
-The documentation for simplekv is available at
-https://simplekv.readthedocs.io.
+The documentation for minimalkv is available at
+https://minimalkv.readthedocs.io.
 
 License
 -------
-simplekv is `MIT licensed
+minimalkv is `MIT licensed
 <http://www.opensource.org/licenses/mit-license.php>`_.
diff --git a/docs/Makefile b/docs/Makefile
@@ -61,9 +61,9 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/simplekv.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/minimalkv.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/simplekv.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/minimalkv.qhc"
 
 latex:
 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

diff --git a/docs/azure.rst b/docs/azure.rst
@@ -6,14 +6,14 @@ Simplekv supports storing data in `Microsoft Azure Block Blob Storage <https://a
 The backend uses the `azure-storage-blob <https://github.com/Azure/azure-storage-python/tree/master/azure-storage-blob>`_
 python distribution to access the azure blob storage and currently supports versions 2.x and 12.x.
 
-Note that ``azure-storage-blob`` is not a dependency for simplekv. You need to install it
+Note that ``azure-storage-blob`` is not a dependency for minimalkv. You need to install it
 manually, otherwise you will see an :exc:`~exceptions.ImportError`.
 
 Here is a short example:
 
 ::
 
-   from simplekv.net.azurestore import AzureBlockBlobStore
+   from minimalkv.net.azurestore import AzureBlockBlobStore
 
    conn_string = 'DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;'
 
@@ -49,4 +49,4 @@ before running the tests.
 
 To skip the tests of the azure backend, comment out the ``account_name`` in the ``azure_credentials.ini`` file.
 
-.. autoclass:: simplekv.net.azurestore.AzureBlockBlobStore
+.. autoclass:: minimalkv.net.azurestore.AzureBlockBlobStore
diff --git a/docs/boto.rst b/docs/boto.rst
@@ -3,31 +3,31 @@
 
 Network and cloud-based storage
 *******************************
-A core feature of simplekv is the ability to transparently store data using
+A core feature of minimalkv is the ability to transparently store data using
 cloud storage services like `Amazon S3 <http://aws.amazon.com/s3/>`_ and `Google
 Storage <http://code.google.com/apis/storage/>`_. This is achieved by providing
 a backend that utilizes `boto <http://boto.cloudhackers.com/>`_ (preferably >=
 2.25).
 
 ``boto`` doesn't support using Google Storage with Python3. For this
-reason simplekv has a separate Google Storage implementation for Python3 at
-:class:`~simplekv.net.gcstore.GoogleCloudStore` which uses Google's
+reason minimalkv has a separate Google Storage implementation for Python3 at
+:class:`~minimalkv.net.gcstore.GoogleCloudStore` which uses Google's
 ``google-cloud-storage`` library.
 
-Note that boto is not a dependency for simplekv. You need to install it
+Note that boto is not a dependency for minimalkv. You need to install it
 manually, otherwise you will see an :exc:`~exceptions.ImportError`.
 
 Here is a short example:
 
 ::
 
-   from simplekv.net.botostore import BotoStore
+   from minimalkv.net.botostore import BotoStore
    import boto
 
    con = boto.connect_s3('your_access_key', 'your_secret_key')
 
    # use get_bucket instead, if you already have one!
-   bucket = con.create_bucket('simplekv-testbucket')
+   bucket = con.create_bucket('minimalkv-testbucket')
 
    store = BotoStore(bucket)
 
@@ -44,7 +44,7 @@ Unit testing
 
 The unit-tests for the boto storage can only run if you have access to a Google
 Storage and/or Amazon S3 account. The tests will look in a file
-``boto_credentials.ini`` in the simplekv source root folder for account
+``boto_credentials.ini`` in the minimalkv source root folder for account
 credentials, here is an example file:
 
 ::
@@ -64,7 +64,7 @@ If a section is not present, the tests for that backend will be skipped.
 The unit tests for S3 will be run by travis against a local minio instance, emulating S3.
 
 
-.. class:: simplekv.net.boto.BotoStore
+.. class:: minimalkv.net.boto.BotoStore
 
    Backend using the storage api of boto.
 

diff --git a/docs/cache.rst b/docs/cache.rst
@@ -2,16 +2,16 @@ kv-caches
 *********
 
 Caches speed up access to stores greatly, if used right. Usually, these require
-combining two :class:`~simplekv.KeyValueStore` instances of the same or different
+combining two :class:`~minimalkv.KeyValueStore` instances of the same or different
 kind. A simple example without error-handling is a store that uses a
-:class:`~simplekv.memory.redisstore.RedisStore` in front of a
-:class:`~simplekv.fs.FilesystemStore`:
+:class:`~minimalkv.memory.redisstore.RedisStore` in front of a
+:class:`~minimalkv.fs.FilesystemStore`:
 
 ::
 
-  from simplekv.memory.redisstore import RedisStore
-  from simplekv.fs import FilesystemStore
-  from simplekv.cache import CacheDecorator
+  from minimalkv.memory.redisstore import RedisStore
+  from minimalkv.fs import FilesystemStore
+  from minimalkv.cache import CacheDecorator
 
   from redis import StrictRedis
 
@@ -32,5 +32,5 @@ kind. A simple example without error-handling is a store that uses a
   # any further calls to store.get('some_value') will be served from the
   # RedisStore now
 
-.. automodule:: simplekv.cache
+.. automodule:: minimalkv.cache
    :members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# simplekv documentation build configuration file, created by
+# minimalkv documentation build configuration file, created by
 # sphinx-quickstart on Tue May 10 09:07:13 2011.
 #
 # This file is execfile()d with the current directory set to its containing
@@ -51,7 +51,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'simplekv'
+project = u'minimalkv'
 copyright = u'2011, Marc Brinkmann'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -166,7 +166,7 @@
 #html_file_suffix = ''
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'simplekvdoc'
+htmlhelp_basename = 'minimalkvdoc'
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -181,7 +181,7 @@
 # (source start file, target name, title, author, documentclass
 # [howto/manual]).
 latex_documents = [
-  ('index', 'simplekv.tex', u'simplekv Documentation',
+  ('index', 'minimalkv.tex', u'minimalkv Documentation',
    u'Marc Brinkmann', 'manual'),
 ]
 

diff --git a/docs/crypt.rst b/docs/crypt.rst
@@ -1,5 +1,5 @@
 Hash and encryption decorators
 ******************************
 
-.. automodule:: simplekv.crypt
+.. automodule:: minimalkv.crypt
    :members:
diff --git a/docs/db.rst b/docs/db.rst
@@ -12,7 +12,7 @@ based store is available:
 
 ::
 
-  from simplekv.db.sql import SQLAlchemyStore
+  from minimalkv.db.sql import SQLAlchemyStore
   from sqlalchemy import create_engine, MetaData
 
   # use echo=True to see queries
@@ -32,7 +32,7 @@ based store is available:
 
   print(store.get(u'my_key'))
 
-.. class:: simplekv.db.sql.SQLAlchemyStore
+.. class:: minimalkv.db.sql.SQLAlchemyStore
 
    Stores data in a table in a database through `SQLAlchemy
    <http://sqlalchemy.org>`_.
@@ -44,7 +44,7 @@ based store is available:
    .. method:: __init__(bind, metadata, tablename)
 
       Generates a new :class:`~sqlalchemy.schema.Table` for use as a
-      backend (see :attr:`~simplekv.db.sql.SQLAlchemyStore.table`) on the
+      backend (see :attr:`~minimalkv.db.sql.SQLAlchemyStore.table`) on the
       supplied metadata.
 
       :param bind: Any queries made by the store run
@@ -63,10 +63,10 @@ based store is available:
 MongoDB
 -------
 
-The :class:`~simplekv.db.mongo.MongoStore` class requires the ``pymongo``
+The :class:`~minimalkv.db.mongo.MongoStore` class requires the ``pymongo``
 package to be installed.
 
-.. class:: simplekv.db.mongo.MongoStore
+.. class:: minimalkv.db.mongo.MongoStore
 
    .. method:: __init__(db, collection)
 

diff --git a/docs/decorators.rst b/docs/decorators.rst
@@ -1,6 +1,6 @@
 Other decorators
 ****************
 
-.. autoclass:: simplekv.decorator.PrefixDecorator
-.. autoclass:: simplekv.decorator.URLEncodeKeysDecorator
-.. autoclass:: simplekv.decorator.ReadOnlyDecorator
+.. autoclass:: minimalkv.decorator.PrefixDecorator
+.. autoclass:: minimalkv.decorator.URLEncodeKeysDecorator
+.. autoclass:: minimalkv.decorator.ReadOnlyDecorator
diff --git a/docs/development.rst b/docs/development.rst
@@ -4,6 +4,6 @@ Development
 Github
 ======
 All official development of the library takes place on `GitHub
-<https://github.com/mbr/simplekv>`_. Comments, bug reports and patches are
+<https://github.com/data-engineering-collective/minimalkv>`_. Comments, bug reports and patches are
 usually welcome, if you have any questions regarding the library, you can message
 the author there as well.
diff --git a/docs/filesystem.rst b/docs/filesystem.rst
@@ -2,8 +2,8 @@ Filesystem-based key-value stores
 *********************************
 
 A straightforward implementation is a filesystem-based implementation found in
-:class:`simplekv.fs.FilesystemStore` class, as well as a slightly altered
-version suitable for web applications, :class:`simplekv.fs.WebFilesystemStore`.
+:class:`minimalkv.fs.FilesystemStore` class, as well as a slightly altered
+version suitable for web applications, :class:`minimalkv.fs.WebFilesystemStore`.
 
-.. automodule:: simplekv.fs
+.. automodule:: minimalkv.fs
    :members:
diff --git a/docs/gae.rst b/docs/gae.rst
@@ -6,7 +6,7 @@ Currently, there is support for storing data on `Google app engine
 for storing small bits of data, like sessions or similiar but not large binary
 blobs [1]_.
 
-.. class:: simplekv.gae.NdbStore
+.. class:: minimalkv.gae.NdbStore
 
    A backend that stores data on ndb objects. The objects key will be the key
    in the kvstore, while an attribute ``v`` must be present on the object to
@@ -22,7 +22,7 @@ Here is a minimal example:
 ::
 
     from google.appengine.ext import ndb
-    from simplekv.gae import NdbStore
+    from minimalkv.gae import NdbStore
 
     class MyKvModel(ndb.Model):
         v = ndb.BlobProperty(indexed=False)
@@ -31,4 +31,4 @@ Here is a minimal example:
 
 
 .. [1] You're welcome to implement it and `submit a patch
-   <https://github.com/mbr/simplekv>`_.
+   <https://github.com/data-engineering-collective/minimalkv>`_.
diff --git a/docs/gcstorage.rst b/docs/gcstorage.rst
@@ -5,17 +5,17 @@ This backend is for storing data in `Google Cloud Storage <https://cloud.google.
 by using the ``google-cloud-storage`` library.
 
 ``google-cloud-storage`` is only available for Python 3. Simplekv also provides access to
-Google Cloud Storage through :class:`~simplekv.net.boto.BotoStore` using the ``boto`` library which is available for Python 2.
+Google Cloud Storage through :class:`~minimalkv.net.boto.BotoStore` using the ``boto`` library which is available for Python 2.
 
 
-Note that ``google-cloud-storage`` is not a dependency for simplekv. You need to install it
+Note that ``google-cloud-storage`` is not a dependency for minimalkv. You need to install it
 manually, otherwise you will see an :exc:`~exceptions.ImportError`.
 
 Here is a short example:
 
 ::
 
-   from simplekv.net.gcstore import GoogleCloudStore
+   from minimalkv.net.gcstore import GoogleCloudStore
 
    credentials_path = "/path/to/credentials.json"
 
@@ -49,5 +49,5 @@ To test against a locally running Fake GCS Server instance make sure to start th
 
 before running the tests.
 
-.. autoclass:: simplekv.net.gcstore.GoogleCloudStore
+.. autoclass:: minimalkv.net.gcstore.GoogleCloudStore
     :members: __init__