Skip to content

Update README. #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 22, 2016
Merged

Update README. #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ cssdbpy

.. image:: https://img.shields.io/pypi/v/cssdbpy.svg?maxAge=2592000?style=flat
.. image:: https://img.shields.io/pypi/l/cssdbpy.svg?maxAge=2592000?style=flat
.. image:: https://img.shields.io/gitter/room/cssdbpy/cssdbpy.svg?maxAge=2592000
.. image:: https://img.shields.io/gitter/room/cssdbpy/cssdbpy.svg?maxAge=2592000
:target: https://gitter.im/deslum_projects/cssdbpy

Cssdbpy is a simple SSDB client written on Cython. Faster standart SSDB client.
Cssdbpy is a simple SSDB client written on Cython. Faster standard SSDB client.


Install
Expand All @@ -29,7 +29,7 @@ Example
from cssdbpy import Connection
from time import time
import md5

if __name__ == '__main__':
conn = Connection('127.0.0.1', 8888)
for i in xrange(0, 1000):
Expand All @@ -56,7 +56,7 @@ MacBook Pro 2012 2,5 GHz Intel Core i5 4 ГБ 1600 МГц DDR3

.. image:: benchmark/bench.png
:height: 100px
:width: 200 px
:scale: 50 %
:width: 200px
:scale: 50%
:alt: alternate text
:align: center
Binary file modified docs/_build/doctrees/code.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/connection.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/.buildinfo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 86c36ab56b94cb00d7b7622af35d81ca
config: 9678d3d110091a4e463b418f1e9129c0
tags: 645f666f9bcd5a90fca523b33c5a78b7
6 changes: 3 additions & 3 deletions docs/_build/html/_sources/code.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Client
.. autoclass:: StrictSSDB


Key/Value
Key/Value
^^^^^^^^^

A container of (key, value) pairs in ssdb. A key name maps a string value.
Expand Down Expand Up @@ -243,11 +243,11 @@ Client
""""""
.. automethod:: StrictSSDB.hrscan


Zsets
^^^^^

A sorted set in ssdb. It's contain keys with scores in ``zset``
A sorted set in ssdb. It contains keys with scores in ``zset``

.. code-block:: python

Expand Down
26 changes: 13 additions & 13 deletions docs/_build/html/_sources/index.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Welcome to ssdbpy's documentation!
Welcome to cssdbpy's documentation!
===================================

What is SSDB?
-------------

SSDB is a high performace key-value(key-string, key-zset, key-hashmap) NoSQL database, an alternative to Redis.
SSDB is stable, production-ready and is widely used by many Internet companies including QIHU 360. It's repository is https://github.com/ideawu/ssdb
SSDB is a high performance key-value(key-string, key-zset, key-hashmap) NoSQL database, an alternative to Redis.
SSDB is stable, production-ready and is widely used by many Internet companies including QIHU 360. Its repository is https://github.com/ideawu/ssdb


Features
Expand All @@ -22,33 +22,33 @@ Features
* Built-in CLI nagios self-checks


About ssdbpy
About cssdbpy
-------------

ssdbpy is a simple SSDB client written on Cython. 5x faster standart ssdb client.
It's repository is https://github.com/deslum/ssdbpy
cssdbpy is a simple SSDB client written on Cython. 5x faster standard ssdb client.
Its repository is https://github.com/deslum/cssdbpy


Install
-------

.. code-block:: bash

pip install ssdbpy
pip install cssdbpy

or

.. code-block:: bash

pip install https://github.com/deslum/ssdbpy
pip install https://github.com/deslum/cssdbpy/archive/master.zip

Connection
----------

.. code-block:: python

>>> from ssdbpy import SSDBPy
>>> ssdb = SSDBPy('127.0.0.1', 8888)
>>> from cssdbpy import Connection
>>> ssdb = Connection('127.0.0.1', 8888)

hset
---------------
Expand All @@ -61,7 +61,7 @@ Set the string value in argument as value of the key of a hashmap.

hget
----
Get the value related to the specified key of a hashmap
Get the value related to the specified key of a hashmap.

.. code-block:: python

Expand Down Expand Up @@ -91,7 +91,7 @@ Increment the number stored at key in a hashmap by num. The num argument could b
hscan
-----

List key-value pairs of a hashmap with keys in range (key_start, key_end]
List key-value pairs of a hashmap with keys in range (key_start, key_end].

.. code-block:: python

Expand Down Expand Up @@ -121,7 +121,7 @@ Return the number of key-value pairs in the hashmap.
hlist
-----

List hashmap names in range (name_start, name_end]
List hashmap names in range (name_start, name_end].

.. code-block:: python

Expand Down
Binary file modified docs/_build/html/objects.inv
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions docs/code.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Client
.. autoclass:: StrictSSDB


Key/Value
Key/Value
^^^^^^^^^

A container of (key, value) pairs in ssdb. A key name maps a string value.
Expand Down Expand Up @@ -243,11 +243,11 @@ Client
""""""
.. automethod:: StrictSSDB.hrscan


Zsets
^^^^^

A sorted set in ssdb. It's contain keys with scores in ``zset``
A sorted set in ssdb. It contains keys with scores in ``zset``

.. code-block:: python

Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx.ext.autodoc",
]
"sphinx.ext.autodoc",
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
14 changes: 7 additions & 7 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Welcome to cssdbpy's documentation!
What is SSDB?
-------------

SSDB is a high performace key-value(key-string, key-zset, key-hashmap) NoSQL database, an alternative to Redis.
SSDB is stable, production-ready and is widely used by many Internet companies including QIHU 360. It's repository is https://github.com/ideawu/ssdb
SSDB is a high performance key-value(key-string, key-zset, key-hashmap) NoSQL database, an alternative to Redis.
SSDB is stable, production-ready and is widely used by many Internet companies including QIHU 360. Its repository is https://github.com/ideawu/ssdb


Features
Expand All @@ -25,8 +25,8 @@ Features
About cssdbpy
-------------

cssdbpy is a simple SSDB client written on Cython. 5x faster standart ssdb client.
It's repository is https://github.com/deslum/cssdbpy
cssdbpy is a simple SSDB client written on Cython. 5x faster standard ssdb client.
Its repository is https://github.com/deslum/cssdbpy


Install
Expand Down Expand Up @@ -61,7 +61,7 @@ Set the string value in argument as value of the key of a hashmap.

hget
----
Get the value related to the specified key of a hashmap
Get the value related to the specified key of a hashmap.

.. code-block:: python

Expand Down Expand Up @@ -91,7 +91,7 @@ Increment the number stored at key in a hashmap by num. The num argument could b
hscan
-----

List key-value pairs of a hashmap with keys in range (key_start, key_end]
List key-value pairs of a hashmap with keys in range (key_start, key_end].

.. code-block:: python

Expand Down Expand Up @@ -121,7 +121,7 @@ Return the number of key-value pairs in the hashmap.
hlist
-----

List hashmap names in range (name_start, name_end]
List hashmap names in range (name_start, name_end].

.. code-block:: python

Expand Down