From cb4c6d8bc101c2d721aa32b9b08794d466d49d51 Mon Sep 17 00:00:00 2001 From: Oluwafemi Sule Date: Thu, 22 Sep 2016 07:20:43 +0100 Subject: [PATCH] Update README. * Correct package name * Update sentence * Format doc build configuration --- README.rst | 10 ++++----- docs/_build/doctrees/code.doctree | Bin 3257 -> 3263 bytes docs/_build/doctrees/connection.doctree | Bin 3294 -> 3302 bytes docs/_build/doctrees/environment.pickle | Bin 10055 -> 10050 bytes docs/_build/doctrees/index.doctree | Bin 19815 -> 19884 bytes docs/_build/html/.buildinfo | 2 +- docs/_build/html/_sources/code.txt | 6 +++--- docs/_build/html/_sources/index.txt | 26 ++++++++++++------------ docs/_build/html/objects.inv | Bin 270 -> 271 bytes docs/_build/html/searchindex.js | 2 +- docs/code.rst | 6 +++--- docs/conf.py | 4 ++-- docs/index.rst | 14 ++++++------- 13 files changed, 35 insertions(+), 35 deletions(-) diff --git a/README.rst b/README.rst index 59f9c3c..1b423c8 100755 --- a/README.rst +++ b/README.rst @@ -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 @@ -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): @@ -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 diff --git a/docs/_build/doctrees/code.doctree b/docs/_build/doctrees/code.doctree index 07ce927e2afff4a111b74f9f95dde9174f0f0e88..d5347de9d41794a570fe7d71fcbe099eeb6db956 100644 GIT binary patch delta 151 zcmdlfxnFX^3l$Rv1_u4m;?$yI{rsHL^2D^%+|1(AoK*eb%#ze%egEKK{p8Iej1L$Y zZ6^n^bSa=J(ksg>Dk)9ONzE%O)=$exEY6-hgV~1BaFSps?;KVm;B_?+|<01V*TRcl%#@6-IV;~ vV*SlLj1L$Y%_ax1bV*`WT$Y+wHu)Ee4Wq?mbJobox-3e>soreP+QAM0+Uzrz diff --git a/docs/_build/doctrees/connection.doctree b/docs/_build/doctrees/connection.doctree index cfe27037344b5ea861ccb07488aa06018469f95f..fb8a4b384a433f599198fd3ae54e2502410a1ab4 100644 GIT binary patch delta 298 zcmca7`Al-c8x<=C1_u4m;?$yI{rsHL^2D^%+|1(AoK*eb%#ze%egEKK{p8IOj2{^p zT_@+U^eLb!(ksg>Dk)9ONzE%O)=$exEY6<1k=cgPa`HRodQvsSZeGut!IoY)KU6F& zGbc4ZGY{yhlFa}mAOgzIq_-v`6YSzC8_bnC5c5Pg^RrzLYXsDiVK(27A~D!!z0DJthR7@hG>RT hhInn^iph(4)J0at7Oo0qD@siRsasuJxTZ8o4*=YXa_ay9 delta 268 zcmaDRc~5e}8yzPG1_u4m;?$yI{i4LYl>FSps?;KVm;B_?+|<01V*TRcl%#@6-IV;~ zV*Skmj2{^p?I!24^hsh>T$Y+wHhBZH4Wq^6x6JiKtBl>el{JHHvOJHZ%KVN{?xMu< z_|&|_q@2{0!Uf)pp}Z-jxdrjXsU;;(G^w~Gv!t{nGe0jrFEKZ@xNvE0;j#?T45bY5+QQ|NSM#WgtcWdK8Om0ang-Im LsCanp=>QSdto$ zSd^GsTo~e)p*ndv%K{Z^ph5bf#i>Qb`uRDf<%wyjxtYbKIjQ==nI);k`u@Se`pJ`v zSqoIOiBZVURxZGvTwI)zR8U!17$FMOlRS9}+c75YIWZ}}v_yBZEuXnM4^WpQh^qiK_j_w&;g8zFpBfor5eUi6bNT*>%G^oy eF}T27fK6wWwy;@zwh+xcl?Qn60RpY8RgO@pF{27@J3LgXNY1tSzyoArd*Wq-Us zPLv3N)Jkyd&)h&&C5{Mz#2#9yD2iyssZuXosuVbaxKtc^(*B48#Ys^#tFCzWv}5t z*Jdl#7>SXqZbG}GQf;GwqC?rSxk{C0v>VX%RLgXa+KEbam>}y=S1beao)xAYbNQNe zKxr7z^khoT+MUhBs;M}3*ALr0Lb6hAr`az;Pu6ui)g)Yk8?K$+t)*C|2^E?Ee*s=z zWdk)rpk@RyQX_=;9pPT^xM8=fqp_k3C0Y*T}hoZ}gT^HJ(m{S9F!UeUUxsk)p%+V5S`? z_)PB!@_je!-`?DN&&<98$l}+1pAyEeedW;i2R=CsQr)CC!#o6}-`Z?;YsO zz#pK5zspQyn)@Qkj)K%RC>pZsL8rK>)^Q=T@?p|eM&>4i2`$nIb>sYjts|#M8*_7W z{HkLa;cvjJM%{8ezPz`_ETsek`f?wN2M5Zg?5)mv#6+jMUg|=&(!3!zo`+mSM+>R jJ4MZBTAqTRYdpYzE%c{GvcQnO2NE?zqeqWijN8#f6QeQSjPboU69Q2#p1$wYF5ijoTYJ4_ckv3(-}XK=Ooc88Iq~f>5LD>z?7FHok?dZaFA6c(a@{X83sjq zNir>2E0_a1o6ZD~vH(PjlTFSvbF%|_z?~o$vW8xr&akLLoYhJe$rl&(U^-KYr_M{3 z*rlp^$ZfbNEt-0bvm~n(3Q`uY(Zi0CFR7M119FlId#KOL5f_BFG#>9QF7hUy)3T+! zRIo(S*aB$5zX8??7{TXYMM0HN;X<_mR-iYK^cV;TEau^5lg!oQpc?fNm;?w4EJ5M> zot=6TgoH{$fE=fje z)MYSJE*63^Q}AwiG1MXozJi!XR~nnvPXa&O>m4CSJ-6kk^Z(EqSA56lxCl_=Gzh@7 z?==)F*Qh9r*B^ktDspbL&)@5Kb_2~&bSr7N3TQjVyrtPB4vk6*-7W}2b*&6O?GQOF z9I89MIb5k5@ZLaKc&C0O>|CD9sxrDwJ2PhCwQ(raAKxzh4W+l~)Ebf$2Y)y0flnGn z9M9gpW0DGm(Ym5s?=Iyzp4l>{j7RlgOqB=>#SX z!_2O=u3A9HfPs2LVFH8nasxyaxw9?A8&3OuuW;eYyU-=2t*r2<>GPlE8g%6{Uq8au+j^RQ8( zggr=MY`P;~PIbbsUET0u*P!Fs&4(r^mM3MWaaqV-?q2t>ZA6i=Qf1Hdp7paGM0t*t zTKmP|BM%!R%6qJ^_T`bI^mH7Y2T7$IKcE#XffjHCv?&rUIG|j^CZVk2B(I#nQBrd|1tb1CH%HV2gi7CRLVN6pGT4-AYqG9Ah@EcYnuuxI?zAM6l!I{*Lx diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo index 3a6b290..b345391 100644 --- a/docs/_build/html/.buildinfo +++ b/docs/_build/html/.buildinfo @@ -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 diff --git a/docs/_build/html/_sources/code.txt b/docs/_build/html/_sources/code.txt index ee2dbfb..9b92e15 100644 --- a/docs/_build/html/_sources/code.txt +++ b/docs/_build/html/_sources/code.txt @@ -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. @@ -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 diff --git a/docs/_build/html/_sources/index.txt b/docs/_build/html/_sources/index.txt index 5be9083..c96a9a5 100644 --- a/docs/_build/html/_sources/index.txt +++ b/docs/_build/html/_sources/index.txt @@ -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 @@ -22,11 +22,11 @@ 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 @@ -34,21 +34,21 @@ 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 --------------- @@ -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 @@ -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 @@ -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 diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv index ad009db47d1ce024fcfc7402caa41ca72ed41c7b..555b6958a16272e83677ba272d00998f20b4363f 100644 GIT binary patch delta 61 zcmV-D0K)%{0*?ZaC;?-UD77(wAy7Z9`v3`>U3yCAqMdR=f10MXYljkb6`C#A&cOPK TV+;4hd^#av~WKcD`98LfL diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index d124b8e..eae2d88 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:49,filenames:["code","connection","index"],objects:{},objnames:{},objtypes:{},terms:{"function":[],"import":2,"return":2,"true":[],abc:[],administr:2,all:2,altern:2,api:2,argument:2,arrai:2,assum:2,balanc:2,befor:2,big:[],billion:[],block:[],built:2,call:2,check:2,cli:2,code:[],collect:2,com:2,compani:2,convert:2,could:2,cpy:2,cython:2,data:2,databas:2,delet:2,design:2,deslum:2,element:[],execut:2,exist:[],fast:[],faster:2,first:2,from:2,get:2,github:2,gmail:2,group:[],gui:2,hash:2,hash_1:[],hash_2:[],hash_:[],hash_z:[],hashmap:2,hdecr:[],hexist:[],hget:[],high:2,hlist:[],host:[],hscan:[],hsize:[],http:2,ideawu:2,includ:2,incr:[],increment:2,index:2,instal:2,integ:2,internet:2,java:2,kei:2,key1:[],key2:[],key3:[],key4:[],key5:[],key6:[],key_end:2,key_start:2,leveldb:2,like:[],list:2,liter:2,load:2,log:[],mani:2,map:2,master:2,method:2,modul:[],multi_get:[],multi_hset:[],multi_set:[],multi_zget:[],multi_zset:[],multipl:2,nagio:2,name:2,name_end:2,name_start:2,neg:2,nodej:2,nosql:2,num:2,number:2,old:2,page:[],pair:2,performac:2,persist:2,php:2,phpssdbadmin:2,pip:2,pool:[],port:[],product:2,provid:[],python:2,qihu:2,queue:2,randomaz:2,rang:2,readi:2,redi:2,relat:2,replic:2,repositori:2,rubi:2,scan:[],search:[],see:[],self:2,server:2,servic:2,set:2,set_a:[],set_abc:[],set_b:[],set_c:[],set_count:[],set_d:[],set_ttl:[],set_x1:[],set_x2:[],set_x3:[],set_x4:[],set_x:[],set_xx:[],setx:[],simpl:2,slave:2,sleep:[],specifi:2,stabl:2,standart:2,storag:2,store:2,string:2,support:2,test:2,time:[],tool:2,ttl:[],two:[],type:[],valu:2,whole:2,wide:2,written:2,wrongwaycn:[],zget:[],zkei:[],zrank:[],zrrang:[],zrscan:[],zscan:[],zset:2,zset_1:[],zset_2:[],zset_exist:[]},titles:["Client","Connection","Welcome to ssdbpy’s documentation!"],titleterms:{about:2,client:0,connect:[1,2],content:[],document:2,featur:2,have:[],hclear:2,hdel:2,hget:2,hgetal:2,hincr:2,hkei:2,hlist:2,hscan:2,hset:2,hsize:2,indice:[],install:2,more:[],multi_hdel:2,multi_hget:2,multi_hset:2,question:2,quickstart:[],ssdb:2,ssdbpy:2,tabl:[],welcom:2,what:2,you:[]}}) \ No newline at end of file +Search.setIndex({envversion:49,filenames:["code","connection","index"],objects:{},objnames:{},objtypes:{},terms:{"function":[],"import":2,"return":2,"true":[],abc:[],administr:2,all:2,altern:2,api:2,archiv:2,argument:2,arrai:2,assum:2,balanc:2,befor:2,big:[],billion:[],block:[],built:2,call:2,check:2,cli:2,code:[],collect:2,com:2,compani:2,convert:2,could:2,cpy:2,cython:2,data:2,databas:2,delet:2,design:2,deslum:2,element:[],execut:2,exist:[],fast:[],faster:2,first:2,from:2,get:2,github:2,gmail:2,group:[],gui:2,hash:2,hash_1:[],hash_2:[],hash_:[],hash_z:[],hashmap:2,hdecr:[],hexist:[],hget:[],high:2,hlist:[],host:[],hscan:[],hsize:[],http:2,ideawu:2,includ:2,incr:[],increment:2,index:2,instal:2,integ:2,internet:2,java:2,kei:2,key1:[],key2:[],key3:[],key4:[],key5:[],key6:[],key_end:2,key_start:2,leveldb:2,like:[],list:2,liter:2,load:2,log:[],mani:2,map:2,master:2,method:2,modul:[],multi_get:[],multi_hset:[],multi_set:[],multi_zget:[],multi_zset:[],multipl:2,nagio:2,name:2,name_end:2,name_start:2,neg:2,nodej:2,nosql:2,num:2,number:2,old:2,page:[],pair:2,perform:2,performac:[],persist:2,php:2,phpssdbadmin:2,pip:2,pool:[],port:[],product:2,provid:[],python:2,qihu:2,queue:2,randomaz:2,rang:2,readi:2,redi:2,relat:2,replic:2,repositori:2,rubi:2,scan:[],search:[],see:[],self:2,server:2,servic:2,set:2,set_a:[],set_abc:[],set_b:[],set_c:[],set_count:[],set_d:[],set_ttl:[],set_x1:[],set_x2:[],set_x3:[],set_x4:[],set_x:[],set_xx:[],setx:[],simpl:2,slave:2,sleep:[],specifi:2,stabl:2,standard:2,standart:[],storag:2,store:2,string:2,support:2,test:2,time:[],tool:2,ttl:[],two:[],type:[],valu:2,whole:2,wide:2,written:2,wrongwaycn:[],zget:[],zip:2,zkei:[],zrank:[],zrrang:[],zrscan:[],zscan:[],zset:2,zset_1:[],zset_2:[],zset_exist:[]},titles:["Client","Connection","Welcome to cssdbpy’s documentation!"],titleterms:{about:2,client:0,connect:[1,2],content:[],cssdbpy:2,document:2,featur:2,have:[],hclear:2,hdel:2,hget:2,hgetal:2,hincr:2,hkei:2,hlist:2,hscan:2,hset:2,hsize:2,indice:[],install:2,more:[],multi_hdel:2,multi_hget:2,multi_hset:2,question:2,quickstart:[],ssdb:2,ssdbpy:[],tabl:[],welcom:2,what:2,you:[]}}) \ No newline at end of file diff --git a/docs/code.rst b/docs/code.rst index ee2dbfb..9b92e15 100644 --- a/docs/code.rst +++ b/docs/code.rst @@ -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. @@ -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 diff --git a/docs/conf.py b/docs/conf.py index 1aae686..a80cf51 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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'] diff --git a/docs/index.rst b/docs/index.rst index b7f3bcc..c96a9a5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 @@ -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 @@ -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 @@ -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 @@ -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