From 514d40357aec1d97ea57eb4341ceb3979259e51c Mon Sep 17 00:00:00 2001 From: Charles Leifer Date: Sun, 9 Dec 2012 17:26:46 -0600 Subject: [PATCH] Adding docs for sqlite and images --- docs/index.rst | 15 ++++++++++++++- docs/mysql.png | Bin 0 -> 1345 bytes docs/peewee/cookbook.rst | 32 ++++++++++++++++++++++++++++++++ docs/peewee/playhouse.rst | 1 + docs/peewee/upgrading.rst | 2 +- docs/postgresql.png | Bin 0 -> 4181 bytes docs/sqlite.png | Bin 0 -> 2471 bytes 7 files changed, 48 insertions(+), 2 deletions(-) create mode 100644 docs/mysql.png create mode 100644 docs/postgresql.png create mode 100644 docs/sqlite.png diff --git a/docs/index.rst b/docs/index.rst index fdecd0667..4684fb9cb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,9 +6,22 @@ peewee ====== -* a small orm +* a small, expressive orm * written in python +.. image:: postgresql.png + :target: peewee/cookbook.html#using-with-postgresql + :alt: postgresql + +.. image:: mysql.png + :target: peewee/cookbook.html#using-with-mysql + :alt: mysql + +.. image:: sqlite.png + :target: peewee/cookbook.html#using-with-sqlite + :alt: sqlite + + See notes on :ref:`notes on upgrading and changes from 1.0 ` Contents: diff --git a/docs/mysql.png b/docs/mysql.png new file mode 100644 index 0000000000000000000000000000000000000000..be24aae4c7bf417dc7d5d6b1936a75f7a68c6a09 GIT binary patch literal 1345 zcmV-H1-|-;P)H=bm`R2_gd7O2u!T$O3_4)ha?eg{X_5115>+|;2*4Ovkx9jZf^2LeF z;pwZ*+0*6g`Qyb2X^-iiJF2U$WTLvB#na}KBpP*@GJ~T-jH&@$h7oFz$;-^{vu61C z`1R7HYNfr6yUkjhwz}5gl)lfg(cSv|{rvp=t*)_0kgcJ{)r7XmpP{5Lf}>HGv*?>N z>#0(qq^9!s_zxQ2*}zS-ikv$fsp@R^&PLtth^M>T>5Pt%@xOh>#>v3J z!yk8=mYACrbeJc8pN^4~>7YM0ho=Ak{|#@H0001xkdXNM`~Lj-{{H{3&)nwc=s=CD z|Ns79pt$(pzs}Cj{QdpbC;la!aGr>Xe4Y3S+dZm7Th z`}fAn&XALpm6wFVK1Sre)Vo*k%*Px>wDeDOLq3;%#2%f^Z56ufBs zcfh4bD&E5Az!)uGvypLeAvz*Zu=)Yhvglz#b8cV)O# zH$Gv3R}aT8HHxgvJOItl{Ni&`3v6$9QNgj^@_5)_FodSNT6i;vP&9<{0m}xm29sH@ zBlpGdp>Z~C)}g3wd_uCP)9FN_35kvm9Jy=OGvGqtS&XqK4VQiSZoZZ(0GN@mZ`M`^ z0aJ^_0iE%X#FB+AZ*m82scNXUXC!TC?>zzB%#rDi6el21VLh;orK^yJM9_n@-DEx7 z$8as>fcg?_K6C}NNa9kD6GRb7T%+UTs5v|#(YDRuut+D-q9|ON-r|5-2dIKn3wUmc zF?a3a!iwy?4?&T_Xmcwhs+uJ;?>M!pZLO9AlrTdL*m9XD6IEriSwETRD&Sx@(N%P% z(_tz2$So+EgNf_t>-D;&Gw{h(bpP$I!^z9WZvh4XDrDiZHL)y^00000NkvXXu0mjf Doe$9D literal 0 HcmV?d00001 diff --git a/docs/peewee/cookbook.rst b/docs/peewee/cookbook.rst index 87a88e6de..5f67d5fd6 100644 --- a/docs/peewee/cookbook.rst +++ b/docs/peewee/cookbook.rst @@ -89,6 +89,8 @@ you wish to use, and then all your models will extend it: otherwise peewee will fall back to a default sqlite database named "peewee.db". +.. _postgresql: + Using with Postgresql ^^^^^^^^^^^^^^^^^^^^^ @@ -109,6 +111,8 @@ Point models at an instance of :py:class:`PostgresqlDatabase`. # etc, etc +.. _mysql: + Using with MySQL ^^^^^^^^^^^^^^^^ @@ -133,6 +137,34 @@ Point models at an instance of :py:class:`MySQLDatabase`. mysql_db.connect() +.. _sqlite: + +Using with SQLite +^^^^^^^^^^^^^^^^^ + +Point models at an instance of :py:class:`SqliteDatabase`. See also :ref:`Alternate Python SQLite Driver `_, +it's really neat. + + +.. code-block:: python + + sqlite_db = SqliteDatabase('sq.db') + + + class SqliteModel(Model): + """A base model that will use our Sqlite database""" + class Meta: + database = sqlite_db + + class User(SqliteModel): + username = CharField() + # etc, etc + + + # when you're ready to start querying, remember to connect + sqlite_db.connect() + + Multi-threaded applications ^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/peewee/playhouse.rst b/docs/peewee/playhouse.rst index 6d081badd..864324a6d 100644 --- a/docs/peewee/playhouse.rst +++ b/docs/peewee/playhouse.rst @@ -7,6 +7,7 @@ Peewee comes with numerous extras which I didn't really feel like including in the main source module, but which might be interesting to implementers or fun to mess around with. +.. _apsw: apsw, an advanced sqlite driver ------------------------------- diff --git a/docs/peewee/upgrading.rst b/docs/peewee/upgrading.rst index 51e10fffd..fc755464a 100644 --- a/docs/peewee/upgrading.rst +++ b/docs/peewee/upgrading.rst @@ -3,7 +3,7 @@ Upgrading peewee ================ -Peewee went from 2319 SLOC to 1666. +Peewee went from 2319 source lines of code to ~1600 between 1.0 and 2.0. Goals for the new API --------------------- diff --git a/docs/postgresql.png b/docs/postgresql.png new file mode 100644 index 0000000000000000000000000000000000000000..dbfe9dc8bb6b645bce61391a4ea85dd917705ec2 GIT binary patch literal 4181 zcmV-b5UTHqP)Px#24YJ`L;(K){{a7>y{D4^000SaNLh0L01FcU01FcV0GgZ_00007bV*G`2iyz^ z7A+$DF%Y%@01wqkL_t(&-qo6UbXDcK#(#V7v-dvpIT=nuMo7Y#5D5{KRLYD{C>B;l z5aC+nQn0<&dplg#QkGXO)mmG$w$jSgR(q|K!J$$oKntQwOND@hFa(kiLk5zQoSZ4= z?BV_q5;*1%b**Ywzkl{RdwiewectzdzVADNX__Yg!bAK=yyQwBeAWICt`-5)G!X=$ z?{_E^A`*$9X&Ry^qN*x(yB%4UlfF0*2oMMah{a+Ef`FnZ*lacc+S=M^YilDE3K7>d zxb!VWQSf*?WMpKJm6e4gNl9(Fa#*frxF84w0s;2z-_Mc5hdFolEFGPl=$eKoN!V;Q zd_Es}d3h8T7BX_=NHQ}ssj8}C&z?OTKYkp4dpmJ0j%k7cGiNes(j=@_YhPqP4J07~S0dfDYZvR+ucx`GiQ&VF z7+qY9FT;nTsA!r-FxW*?;|0#v)zQ?_imn^jY&QIUKl!=YTt9vsS=l+*9S#h`Ak@`G zQ}YE3Q=qVD7}Fe*F-Cc>Mz; zNx&i{FK~uw64P{KNn-KTF|4_DGH)C@$vscMiEfyvvIWyL(G8PmOk-+U5x=~1E`Qv( zfd|(;%wPVpiD}cOC6>|NaBSbc9h<7MbjfWz_{ZKs`K2r{w1y(k;h#NZomX|!|1!u zX;nCIyp}gUs^eSp=22aJg2u+i{s5YqnrLonVr+Ri2df*1X?oJK)oYHfo4D;(mP{+> zuluT~ZSrGR6-=&PvoAY9=%bU{uJX~DPx$$!-OQ^fX4=>yG~Gx@R9TX!u5V^gRu+b? z69@$Q1L)}JK+`ocvva6xYEMYMgg$ZU80n5Nc32LXsZL&b?>IJ9<`TKSa96e|3OheI z#ol9QSvIqrbhiV;NbK%$T}PIC7@_NWe*n>F6igG@>L3`2UCn-kOGd?Xor$9dbH25c zn#PMrqDU|rBN*u>7S{%dUSiKNO_OLmPD@9K-@SSOx5LWUMi0R>FFQaG1sqm|a5#h@ z3JKl6uM-=Ffhd3}h-ii}Q2a3r6GgT#rYM_(RrOqG@1iIxjr>e6s%)XY*-vX{2&YX= zDg%1Y>4r%-+Rcc(3`XSpa9I@qrj`}5yZk~J%ba<; zx!3XBn;&4aD!hNJmf^W+Oe`$`(*&XCkm9nD?X|M0s*0k*LcCsY{~Yjoy(o%G<0lQ| z_&f;0z)D*bd+PKHZy#aynrHa!EBo*`t^91oEZRE5TxjoN?u3y<;_-y^@AW>woCza& zxAGjX?mNNItW=`0I1ZaiS0qNbTSGv=Fb%SOUc8FV(c>p5E-uDuwf2udYHBKOkB7Rt zS_&qVaH)4C<**}D~p0@A_@YUrc-^s zmEs|pxE)p$S;FJ6VpnDSfpFjLvcp8Y^sHp_AXpD6;-h$yvOWqP8Ny1mFLLM@G>gTM|WID zfP_XEjcJS;oI#<_&bF8T%EXBi$;im)Kc(#DIzmwbp>9&$c4C@Nex{dM*AC^0-#*ExQKOhN zX;MF0C#cbaf&vN)3)#KrU9KITjl-s3BuQe;Fi3UT5fHf88AiG!oqK_rm<-SJ(bOI! z5{)B%x{+P_ZMQ1Caj2S>_8=?fj7Qf^I)V}GszP^MWBJ?)+M62K_TtN|Sg|5$K8l|% zjT0tJ;JtkZNL3An=A;vk>-`@R1R}9Gk|1JLEqxtR5CnAHz^=$lEi2?eRUM&d3^5sv zE+um?662}Y4szqQ!?|`?4$+uKBo?DEJB>wCN?H3q50I0S!_uWold_>-v7bD7GWF*h zXsEAa#w|XzipU6y<9rgXz8kWVk!d^~Hn9^Lg2Rpc+M%t}01P(?pde zb|0ys`g{xj{>|$cGANZ#T08mPf=SfZoaB$sKFhuL-is)TNyTA50OQ7uBR@Z%E!(y+ z=lW5&Y)Zc}*dyG!+4Rm~Zks-qk$FBskrsMNVf}2C>cU1 z8t=Q_%U`Ee;ZJXUNL5`kkF1)*HAAzB#dQj^(imNk$qR2EAr|W`jRVgOBvIf{^?7z2 zI!Sk2V{-X$w!H8>J9h45&6+hFJ9dm+yLPdA_ikESTNA)1UD&Ftt7GJ-QM~fv7Se`| z=hg?F!);d+(2JtT#m*qp#t!3|pWMuawocwV(TGEl_*!uuzu3H+cPq~k2t`q3%Ychh zrfCxHj#E*b&!em7;Z{s0O_|EkV;}SNuTLb{6(kmq6AT8asHkAwx^-k_WevPCw`kEK zYHMpbc<><09^S%%8i#Xrpcf*7eBdWGJ`WyP(*{;lOGf4>?9J6;&7*smy^x$sw&p3 zS;I5WJj3+q)05{wFP{7EyN^SM4zc6SH~7)5(~u;AxMuY5KO7_7<6y&&7SeM1Bfd3% z0nfj%iES^v3?^*eeU$&+_&TEoXRv6>HH4$F0cU8Y2@^*TAvfK_e?9pscRukq-mK9% z7Ea}ikwZMSh|#5`sER^79!F7>t0!@9m`h4ZShj2#D_5;%bY3dA&zV4bFpNJKMpY!9 z{LvzUjc2&;!Jo4FyDQoG#&)*9@-iQ{Xgs#{UG^WZqcaqxFej}~fnJS50s=m_6Gc%N zlAVs*X`>?)Mpad2Rg7l(n89q^xRKj$zn%H>=TlZzcJ;N`fM((EN6zrWKki}okux}~D!=*9Z&R3+#z&_= z`HVE~S>>=>Wrk$Bcx3quBw5DPbv|jR=bar}S^3mPjvhVA-FM&3+O=zOxm*JS==E4y zS{hroZso=sZ^YyE@Y4q$K)roBr%s+=#>`n178KxcI5}J2MoU{K`59gwSpE%WUq6D* z3w4~UIgLe9F#6h;2}vgXq9~G`?%{X8d4eDO@FzGN4nm<2nx-MkGBan+WY3;GR8&;- zllYc_%A0AL%$PBQ&6_u~di83yY}ra~ZVr`|M=2>Oq59-WDk>(ha>aL;R$h+7;ia{; zh4t(H%%i`0oR_w2Ldh!wW8iP7vW(Mep|-Y`Y160kjoGttxm*kxGKBK-a#B)K5&&OG zMa$<|zgf6&A?4-eY}&Mm#>PhOxMKxNmoDY>>C-&?@WVXv=z6-ky81kpo0o^xX6;d; zf^dbH6Oz)^X;-jWL@qQnbIZbotXQ!kX<&p-b> zt*xyzG&B&2L~yxWl$Mrq^UVth1cUf2mR|9b901_7sW?=D=9X6CeN)i>j{IC39AD(& zUT{9251-GMa7~si#JamtWa%^B0UoCnv?%_L&V&j3m%c|fkYRSaoj@>v!>S@6T(u4v zrb%|1n@)c_;YgVD^z<*Zs`n4sY%Wfc*S?nwpwP^H`BB{iX2b#1t8tlg`<*HRR^xF?jIcuYQ{~*%&{5JT+&}Vwa#G zD~)LU3PszyzN+bDrMekgn9lCK`xrldTtbujrvkX)h8yVU=%n)Shpe185#4~8rlIRb z&+?;YU{e%+eCrhIYfkdf;Yt=RT=<3enk`?3@x9e)$&w{}chxH1+Od;+{%sbo?LUsD z>!i9I4A1rPjqyVfgH5cu^9S5|>*79*^LhC{pq&0kjBq&2tXZ@0xZT`)?>%@kbBSpN zf*zyoLLKkF_a56{e~ZaertrwmfBu=G?<)n+Ye-E^4fo%FKgT~lhS%f9X0s93G(^cl zUS2*o-EPx#24YJ`L;(K){{a7>y{D4^000SaNLh0L01FcU01FcV0GgZ_00007bV*G`2iyz^ z7A_Np!b490000?uMObu0Z*6U5Zgc=ca%Ew3Wn>_CX>@2HM@dakSAh-}000RBNkl^KhRZz91PBBI8OQ(uGMmI`niaJ!wRN?2t#PeQZqS_nS0;- zCA*#S<~j;8axiFh08Gx>ur1Bwr&N9~z&-%pD!s_a)Hn&@(Y$)<8T1?Ms4T<#71y}c z-w86L$He3Icu0(h^wH}a8DPP_%(%_E?mEj(2Q7oWY>Q7>12AE;A_^kmrr`e`!0EgK zYRs*4jP&!DOCONGbvwC9sc8JvK9kN@l+rTLOHz0=XZIf@Kxd$TVwCs3x=KVqFeZa> zWrrPh08*pl*8O;p(VyR*eaYwDf_)iTmRYnfF)=%XQKLhpP#}upx@!m<#el=*9|Ju#K1@(R(a)!gdqfF7IUiTupvyAIFOEKiNpIxMDl$#asfNVxND@M$IA3{{&fx*PvW&~^#;Da185BxtR4mI*2iKdb5e1R$iK(2~ zTZ|xpxY5!0DOEgIc$8O9JxlM{FmGJBfZOBYMoR;6A>sEKzwC5yYIgyP_GR9>`Y~>g z8>h#G7akbgb)BtzP;s56J~QoueaOhDRVrRAKEdzK{hXH$o*+9Rh4SWlG%7WcDAL%| z!N7zCcmRMq5)%?eR(uM!#d$g{15C}$k{O@uqvQ5?_`~^s&@(#B&XlbzEG^PEZo%nt zAp%B?Zo@3+_Ig=z*oiO&lbf7Ient)oQ6fDyVNGvvatv9Pd1_A~M{@EIL=n5oc^5!s zTN4{)Q|tUJ{S%`g2zb3RYNd+dsc|12Nfgm*w6qTNpx0=SkNfbzqjG<+)2Zzf^ zfX+a8U=T`$0*A{@_vkQlOAFL@w=-dzL6Rg=B4aqbeK(PTA=nn@aX43YG$k?yNfao# zS;i~J&!ChPl-;TY;I&WQLli}x-dlurHL)lFvg1>zZf~ZtwFzl8+V5Oo3dPFqo!x&B zgI3GF^ehnIO5NAIRr=BD2}pp9BuXe1O3vjUK_N;QHF_p&GrV*C6GTBo6vdU3cDrck z?jR~Kl=RpHS_ga3X*2+6RDSGB&*nx;J%22DmtQ?`hK$%GEYnk{luGubW)f}+!eX67 z5Cq>WWF8ry+T6mZbqW~>Hu{qho5Ze^bQF?L#>M4!V;<>eaB>`n%Y~m(iBY4c>~;+= z9Xd&TXe8aEL;SPsGIp1XK!cH(kT8rI9cq=|O6CcR!tL?!MN2!_Lw;}o zn=K-bxjgm&6pxA_6E-Vuj|Z)vngG4w@d0qDu9E7G7St*~0(5#bett-zM08LnNfFV+ zZNQ;^)F75+nd$jimYohvdINg(`drB?djSF4!W`4{v!q1E`qVCxC~ocvm`4Wqs<{EX z%gNl*A`A8OL z{Bx$}Y~-b8l9!r+xXP>ExO{2vYr?RuK}Iw{P|)wY3z%o6_ z#j0|q=jVtD3PG(@QGUCgpB5g&>2XooP(|m+07tgxaWXg`y;_UM>p>DFtn+h}Hdb*c zYbT)rftyF>WLc(dsE?Y?R`hBOY0>f2b+_~K;V0J`Qx&aERGXXGpPr4|<3W@}vg5a4 z&}dn7EF%a4<2EZ>?#b&99e~sA;>{~1gqea!kB%oJE(uW(c>CI?9N)2rh`y?oWuNKI!eq5dXvlF~?xibJhZZEihqskV}- zIU7GabZYHg%Rmp8YAeaxl7ZPW$f2xVBuB>F)14cnqOFnage~k$PJc8Cn!jKD7*P~4 zYIV#nEfN(R%FyH(FBG3ZrBM2`Te>WROw7*U^~wYr{fP|;$6u%aaRDql9sKR;MY7^k z=pVNbVG8DG?w+;rxur#JwA3>_KTAez5;=*f8@5&+T0L-w?R{JN$44pori@d&3b
bL2#aKXd1*DxItela zY