From fb06253e9fa18eb458fa93614bf2a8e4f20f8613 Mon Sep 17 00:00:00 2001 From: Carsten Ehbrecht Date: Mon, 26 Oct 2020 20:10:48 +0100 Subject: [PATCH] added logo and contribution guide --- .github/CONTRIBUTING.md | 6 ++ CONTRIBUTING.rst | 134 -------------------------------- HISTORY.rst | 15 ++-- docs/environment.yml | 1 + docs/source/_static/favicon.ico | Bin 0 -> 3638 bytes docs/source/_static/roocs.png | Bin 0 -> 6774 bytes docs/source/conf.py | 69 ++++++++-------- docs/source/contributing.rst | 58 +++++++++++++- docs/source/development.rst | 6 +- docs/source/index.rst | 1 + requirements_dev.txt | 2 +- 11 files changed, 114 insertions(+), 178 deletions(-) create mode 100644 .github/CONTRIBUTING.md delete mode 100644 CONTRIBUTING.rst create mode 100644 docs/source/_static/favicon.ico create mode 100644 docs/source/_static/roocs.png diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..44391a5 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,6 @@ +# Contributing + +Contributions are welcome, and they are greatly appreciated! +Every little bit helps, and credit will always be given. + +Please read the [Rooki Documentation](https://rooki.readthedocs.io/en/latest/) to get started. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index 4246906..0000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,134 +0,0 @@ - -Contributing -============ - -Contributions are welcome, and they are greatly appreciated! Every little bit -helps, and credit will always be given. - -You can contribute in many ways: - -Types of Contributions ----------------------- - -Report Bugs -^^^^^^^^^^^ - -Report bugs at https://github.com/roocs/rooki/issues. - -If you are reporting a bug, please include: - -* Your operating system name and version. -* Any details about your local setup that might be helpful in troubleshooting. -* Detailed steps to reproduce the bug. - -Fix Bugs -^^^^^^^^ - -Look through the GitHub issues for bugs. Anything tagged with "bug" and "help -wanted" is open to whoever wants to implement it. - -Implement Features -^^^^^^^^^^^^^^^^^^ - -Look through the GitHub issues for features. Anything tagged with "enhancement" -and "help wanted" is open to whoever wants to implement it. - -Write Documentation -^^^^^^^^^^^^^^^^^^^ - -rooki could always use more documentation, whether as part of the -official rooki docs, in docstrings, or even on the web in blog posts, -articles, and such. - -Submit Feedback -^^^^^^^^^^^^^^^ - -The best way to send feedback is to file an issue at https://github.com/roocs/rooki/issues. - -If you are proposing a feature: - -* Explain in detail how it would work. -* Keep the scope as narrow as possible, to make it easier to implement. -* Remember that this is a volunteer-driven project, and that contributions are welcome :) - -Get Started! -^^^^^^^^^^^^ - -Ready to contribute? Here's how to set up ``rooki`` for local development. - - -#. Fork the ``rooki`` repo on GitHub. -#. - Clone your fork locally: - - $ git clone git@github.com:your_name_here/rooki.git - -#. - Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development: - - $ mkvirtualenv rooki - $ cd rooki/ - $ python setup.py develop - -#. - Create a branch for local development: - - $ git checkout -b name-of-your-bugfix-or-feature - - Now you can make your changes locally. - -#. - When you are done making changes, check that your changes pass flake8 and the - tests, including testing other Python versions with tox: - - $ flake8 rooki tests - $ python setup.py test or py.test - $ tox - - To get flake8 and tox, just pip install them into your virtualenv. - -#. - Commit your changes and push your branch to GitHub: - - $ git add . - $ git commit -m "Your detailed description of your changes." - $ git push origin name-of-your-bugfix-or-feature - -#. - Submit a pull request through the GitHub website. - -Pull Request Guidelines ------------------------ - -Before you submit a pull request, check that it meets these guidelines: - - -#. The pull request should include tests. -#. If the pull request adds functionality, the docs should be updated. Put - your new functionality into a function with a docstring, and add the - feature to the list in README.rst. -#. The pull request should work for Python 3.6 and above. Check - https://travis-ci.org/roocs/rooki/pull_requests - and make sure that the tests pass for all supported Python versions. - -Tips ----- - -To run a subset of tests:: - - $ py.test tests.test_rooki - -Deploying ---------- - -A reminder for the maintainers on how to deploy. -Make sure all your changes are committed (including an entry in HISTORY.rst). -Then run: - -.. code-block:: console - - $ bumpversion patch # possible: major / minor / patch - $ git push - $ git push --tags - -Travis will then deploy to PyPI if tests pass. diff --git a/HISTORY.rst b/HISTORY.rst index 35c7919..14d1ae8 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -1,10 +1,11 @@ -History -******* +Version History +=============== -0.2.0 (2020-10-21) -================== +v0.2.0 (2020-10-26) +------------------- -Changes: +New Features +^^^^^^^^^^^^ * Lightweight wrapper for birdy WPS client. * Operators to build workflow. @@ -12,7 +13,7 @@ Changes: * Result object to access MetaLink outputs. * Notebooks with usage examples. -0.1.0 (2020-03-19) -================== +v0.1.0 (2020-03-19) +------------------- * First release. diff --git a/docs/environment.yml b/docs/environment.yml index 57aa8de..5d456b3 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -6,4 +6,5 @@ channels: dependencies: - sphinx - nbsphinx +- pandoc - ipython diff --git a/docs/source/_static/favicon.ico b/docs/source/_static/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..4facff7ad8e0ea00c97be432fc26738d411d5f05 GIT binary patch literal 3638 zcmeHJT})G15T1LxDnwFoaxS|Lf`LVQML-`f32)3oAExlM&ETk=% zE4^GogFhG*V`9u2^}$3Rj6aEq@!j~O@x>=i+{Bgj0bPFf%qh1Jl+F6En{48cVdl)t znKNg4&UY>V11u;MK%^WT-vej>VB^Nv_*Xf=7_sFL8wmkorg21|vP7saju#dd;KPRx zfO0v%e*Kz`A3b^m&z?P_`pug+;qv9n;Bva)^y$;o_Wb#CDz99*0-;a{hK7dV+_`h$ z^ZBS9bH01`4(8|Q;rjLKaogFmXW{nk+tiM}FJ^D zcDt#a<2XRZxb^GT)AewTk&`1d?*04s(ACui?d|Pw=+Gf(ZEb~MFi7{Dot+JNd3msX z`*zx6wOS3ewYAXL*huqvyEorH#DH)+bhL9qIA_c>&3k7gY2$Legoo@4B)Y|Xsb~k3M zt8o!B^+gRHpS8!pFxd{5%c12$3R8AkQ3k`Tt*x)GRfM<{1Iy&oaa~<)M%2H>z0cgF zWth}Po2y|1xsJYmtH<;MQ(?2&oTjS$0+XSrs7S$RwK|+{PP*;=9_ z6B?Y{nzn6Jh(w~H(BNn&GI?q0;>Gxui4yPc??glXNeVZ_ckdpJxpU_ZJb3URey^@wy9N&*K7?Dh zZo%Wnk706h5-^%<l7Sjt&?Z83CT>;p)|^aOTVziZ_u+gwA{M;sqTe9*vKW!@$4*#cIS; z#BRjK%F0SSCykvf|1_uY>)TvW2F)=|g6W@fgvNAB6%@jKkv!(fnt9$nBp;&w1 zzyTVA>tM}+K!C2-+uKX=9VNaw_#WU}hWnE+PLh9;-!+b9i*L{DT+Aj(#6IjJzKct- zi`YwWTe5vgE;~uz)cx&SewQP~{H2>g9u|eTpIzZE*#vTd^bZ)L zMX%Rq>071z+X#pf(gAEeDX3(eFBA-t=i9rOAiLG>@p?V>)=eNA5M=o+Z7!eN;R<%O zm~eGPu!n#t;htb-A}`2x{G1sKWvUuny8LQ9I$6JzR+N{NmRFQkX3B)Hyr8|!Vs10E z?`Sqte|ANMN?+EYQ?=~PN)`faf>NnaD3w3T31fa%o&;=C5)0&jCi8wYtxD;9U{xPF z)FS`4=Sw4sfu-aAc`CIi4%4@p^K%+X+)sK=tCZ<;a?(|5t~Vm`oF+%3;g(-Akv}R8 T1tF#_3d#JBrSN%8|E=XOBtMbY literal 0 HcmV?d00001 diff --git a/docs/source/_static/roocs.png b/docs/source/_static/roocs.png new file mode 100644 index 0000000000000000000000000000000000000000..eb41e1f04711ed64ee2e1c6080e5f0f8089eb60c GIT binary patch literal 6774 zcmWleby!nv7{&*J3=kL!f*>_Q7zh#~IdVuzcQ?{Gx}{UP5kbPyh@>#3L%O@9yBogq zo$K1pA3Ntc&%5`2@B8;|5lRa03GgWJKp+r-jI^W*aNhj?1;zy4t@}hcKp+ZX8A&lU zkF4En0>_u;cU>2rZU@H;Q#Bd2?Sv#z7P}<)T0>%CTxv;V#6Qz(@L(-pMcZe6V z1^A==M*Oz~Do&W@wpW)YqM0Mb&1J#Fi1^9!cES}Gyj&ham%){`(~ZlsZn=WhsA#=q zSYsuo>EBk$S}}A&uObzgdpxx??#(g<#_|MHW` zHArLZR!$O3ngPXoJ%ztqONLp$ z`|aUo@!eC(p-G6tlNkoNy!%p#5RRF%rEVd^v9To|B)Jr$R}#*eYhQyd+RjO=+uurx zge6*D{2 zVKn{jrs1AnvNpiY4do;)XP{+(KtG-t7Zzb}+B|Athv3$L{}fHjf^w~YGaJ&5XZ7mXPqD<5&4VG&S8X}ENx-jcop-Yw zO;ujD>e1?mBFP~JwkBE-c8JVzYltXD`12*FKxvhl1YD40NKjXZ4mPa{N$?KxEiVX+ z6%Kq9bkf|7L91ePhvy7=1^W6&Du#USH3Si9qUTsAsus}t0wS}%#@YK zX=RO2S`3nYp-3aKz@KYHbR*c%#{=$A9Cv(4Jo(k&+fXA=#^R7OUfCj^hN|2 z0^SKsG!3}KE)X6JuF}0-jBIIX5!|mgb#-;Mu#i$8zg26>cwh=%!sLu8EG%5>Oa0<| zJ}oRPOhrYdVMRztXy87NY-?-d=H^b958eNlNQxy!f{3ot0-4SY4OO~sjf^S?+V!Qp zPStacP+$43wtc-*@i6-3{&ex--re3lmQi~2Jvbtd*(y9w%g}IfY^=ttC!xH&+-|m3 z%zw=>KA!spf8xNvcZzn-XV0D`FnHFlAjtI1k}Y7#)x$Ls20llKl2eDqEhdNmyAkl` z3P2aXj6@ARd=t-Fn#ulkHlbU+TR?v>>wva98~^hO=i%-~Ip9K+K|k-c zQ>GD@RD?!9ycfA9?kwo~^d03jkDSc*zrP~ve*;}hU3d9Hl*8xLI?KqN9?jNQxNv=W zw7M`dR^V_pJ~ozA$1}R+`r^4~AmsR8qN0MlJRiS@kI$TO^&rqkNkz-{M4C-S^F)tv z7$Mb6lY2!QPo3@b%ES}u2ypOZ=}AYSRdjd#;wp}k z*VbdudqH(1AtE9|t+S=MdpLK4H_e@VCx@i2f&K8H}ZAnGJKWl3R zNbKe0qT0+dGc$$BSKly2cdZVLx*{uySr%RX`i7(_m;n=ZF(|OZR`RK-u`$ijTw8OVK9Z1X;1xkuKJbRRg?<>NUgCGvXQ)Hv`L8?v|7ZEu9Ic4b8Vw@r z1-j1B4|jv>M)w^hsF|s$k6vj5H1djyf>o04R>~x0vH#H3{C~;8(;iO0Da|KFq;nMA z#|aYZxYFg}r$Z92U%zf7dDDqQ`0~&wVxRc-tis>U#%7e?p|Mw(Mxv<~g-Oh=_IrA% z03Nj>TaQE{Z3W|{^*q;-6$YGD;BRFQ4Pp{3J4`rVMW~AJJ7vqwEz^%LA8I$Cs9#U6 zdcjA>n{2JEj~#Kth+1KXl|?DRz<2uU)vLW`T++xoBVT9d41pei)zIG)e~ut# zZ8aXbu#!T5Gk9*bw|ZBOw4O9)2W{tAPNM@K-s2%IZ$s(bs5Ha^%N2dt zieG`g_kzYt7mfZUY!nm39f~C=rD@f+%w7|+XuQAPX=-YUd&%GG_2F>qN0MokmZ_=ugSNAm5F7qJ_j@=}58CN?hCvarM%%H1Fc7SzJ1ExbYnYgnfYRxqVDXv`@#6jcvtTXO9Z?q2|6a-8y!IU-i5e zq+(#kL>WIt+SUTN)!xiceSLkgj_G@7w65;%_(6vQ?k%G|e^L?`JX>zJ$4i>u{*#I)@>zN`j@~ql6P}ov(ec)venccx z>3y+}&t9LKC8;DeFf=R(&8b*$)>@%_`EqxEAMU#O*&fXt$*Nf{&y>g}n2S3iP3%-D ze2YL*cHa4Hwh`sk%qVufK3avoI5moPl9TJZysUTn)|Q8e+DAX!EBarL4&)R)%(*Z6 z4hmoB*^PD41uO8cB@O!DpOk1;xFJ_=ZC4Sp6_gJZSCzL zz?>|Vo$lwFMRKc1yOxoVy-vtNu~Bx?^r9Bq^SG{qmYaP_hhI(>7NLq}{TXkGgin=d z_fs~eEx$Bxqe`L)q0Y9z!tIKsqQ-k7wQQa5^JA+tYpqMAks|mzbMN`yYz*1W+y*>V zp6QNqS6fWJOAYDn{_1H&?uR~ZPEKR)UHENHZSDTd&yuWHxs+=*?0R)GjKR0(b?CRT zmR^fD3+_w51D*et@kmHWY-G8_4%h|{?bR((*H|&l`JD8tlVm!S8lvxG-YqbnES$CW z_fE_6X2)}z*93x%8>=PSeo$tnfo- z=>S)AN?SJdKmn!q`R;U;Y1n=mKF6=a1@8mlt#65?@&u1oS62;vFLxjRdnM)YEU0k+THN+Pn=SqC6Gb0#bKf! z9UT6TCqq9s4f7n2l?ZqA&3q7TmivOI*la?6MMa#3lL2yEofMY(BjBq_Yk`FI|9w0z z>lv|~sx)?W9g8cX0Qq0G(G)ik%zS>CpP!${tZ}N@eyT0Dtb!6+OVRybVYa+Gll>Yr zI-eHi=H?a`X-XM;%#IVk+>3lZ;bHtiNH(BJp7>39(RL3>! zv$+p911e~*iEQpQD$0J(fKixt!$;5$q}Apnx|45S}Z{_`KpCGEg4o>nJ*mK*vCEkZ8SVH}mu* zA|D&zKgKkaSiNX_n!_=6Kyd(;N8jBj@H_>E2+PMAz51atVlYdv zXf(cLT4Wd=Xeltkv!$R5dk@q2F+gq!0geD9s^>k;8qSzMaG zBE^tr8z2;ss~$z6SL(QC+Ux#0@t@YI0R`+F9Jn`C|2XhD$z1%kk>d>$Xcko8yB*5L zE2BEx0o3l`f1}H&avl{QAFu1s{PrX3FK&K*7O=Rcrsfig6zgkUohC`g)|M5`=$LuL zN#fkFy1UBOH|v->Y!$b?nYC2{wWMr8_v>aM`L~xFA`ddD@Ad2K^#!sCXI>tke0j(! zcX6AwtGmkNN;F~0%<21UUTtM(E@S63)~MAy?tKPa*1|Bzib%TNjza+v4hvO*U+26Lmf)kIeBETOM6c&Kuw!Sgm`wbi0 zB^BqazHWvvWphTd`L$qH)@s_%^=g);DJ6YEcc-HO;jo~kx+6(hsl9irfOrj)tWQi# z%zWoSO-*ef$l2-Z>zk_Yrkz{JzqUD?4}cgs1qI#=L=YI}PxHR#h6yIsbTf^`{QM() z#_ZfXn#G5=Cxh>Jd5<*#hVecd*SzZ&>;>3VtL}-XzWzMGb)RZWcp@ZM{&EkVA|Rv) z5(N5rhPjHG8ba9&5g#JYyO-|>fEgOSN_DVQ=3r$tjrK=#Oxz6o&wT}QsoSN#%OPYz zwSBQ>Tvx+!el^?B({RI|1(!d*VG;BMBb{1gtKm^apyvqJ}E_q)7$+IrA{HC|uTRk^E{?l@h+OLQ~ zrbMGmwm`+W_|_S-laD$sE;e@iNy~9BD~-oe;BP_h)AMs`KF6gt;8{SxQ&3Q>9Mv<( zG^7@epPx{=&W;(a4vhS8-O@nTcx3V@uAf-?DN31ITWiQ=v0_}KG_4qa0hN#qEx5s@g+YGKx2nip1oK;m-9r#@|WoKt&%q-E<+%Dk& zhj5qB6`T0Z8DsJ^)#M^IDV>?UJ^SwxORg6>f17u!`ve39SC2f{o+mQMj2Q)D%;y#j z5zN0|_0t@>ZRDF^n`wiq(8#Rf6a=vKrOPv=%P#=IUZeD{A4CBQ*CGMO*Vy2KJ(D;V z%UL5=y5Q$kp`ni*WJ0hI$~m6v>C@BN*YO7_+P=liidlS4M;&C7laoI-Q^akKHXlFZ zjB--uWW0E@Rz)xx$18|S7nxT%m0+)mZTVvwxD#dNa3@VH?s;YH|8^O#J+*^&dwZMO z?{ax!V&XUvFD02(lN#=mW{<6LdEOzRs!xN2YOjLN7tjhDA%4CLu!bS^~Gz=n8EAFU3Cv-xRZ7tvX z&+3w{ep^C$n=Fad$B#=<3&!LrPyS9uk_g%QC2_d@x>exKq@twErw0S9?zT&Q6A3w< zv8f38R#*QHBJSei;-lw%dwDcz=r8;{s$=!&`uZ9m{6>L3rcTI8<$V;@`oH<)E5GIt zJcOmyS$)vSEG0Sl<+dhTfQt*-=M2|c@8txl05;}oqY73g39%D-xIM9%EbkzfOCX8r zSU4+ppLgzi4cJn7EMw{V$DN5Xz_#~SI-;}-$RB!Lk;WPhqdk6<>e{{?GagsHT#R?T*NCl+BQ` z;$?dn-<SKGlyv=f(ANoLW@+mMVVf`0!%|yHSvJuV6Nfh9r}vkq?*S*-n`*4 zs*}ae&d!x>=J)Rad)l%)p2ycpVvgEOB}1q9!_aJn!GQq{@p=FxI9e|AoF4Y)n+AnW z{=T)D7_$oR7&kMt*X;8n-Dw50MO}WfrqAtoQ;*(e)qJlRg&MK=p$0<~ zRbGn3ROgV;?FY+A==L@uci0;@^EOl3vOYm5$jLVk4vJ{BU49*Ck=~4Kow~Q2Q01$a z=3`dqWKu`-#x(mZM;p(8OXa4EZCfn!4HY}nk_4BJJN8@vt4PtcKkBKhblJ#u=UNUm zJ6C6-Z((k5{H&!Kyp(Gacu|j!niqme@LN+u!QpN?N}F2Xd%+7*C`ie?5(Nt~)&f)4^Kp_dunD+)=W0`k4Wa$EB>EWSgGY=Qnw+<8d22{RFc!GqErERbGFRh-8i= z-7a?oaMNL~o^#~c2hE^7_~O+AeNsF(3I%0oZ|A$2frZZg@;srB6H;-KYwHL0Lt&wz zq6X@p$n49d3kiH3HRHU2Vag`(0Ee*f>po|VPlO?f=F>I%Gc~-r7j2bSAJKb`!MWwW z-S=#naVQioFYkiy#eD9}Z)Ry)5fOGN>6K0~(eE$7Lcc|mmF+(_!Yrvsn9;mKQkw*}_~7 zhCN%4z=4L!s)?%!F6$7e-~{B-&ZKd#xMe7Vz$vDx?@djFlGAHhvjUs2TSJ2pVzkhd zzach1K#xIcB&)73g`B<{K(OSNF-7^l$G!V^TMjN6#GuRn7%8}#0pc&xeFawHdn6uV z^-WeHtgvzY>M{7EJ*f3lzjzS2akQk}h#+^rH~~9E=S^p@=zC|{_O#NcA*SJt2E}FA zP%PCF^W`Ub*tC${C|&u)G=)4OJnYtp^jPA*RF5T}Bt77VaMLD0k((iA3Z-o6As zw`62x5TlEp+{g4MQO;E>6Yn?Owz1Rc349}pC2nbxB<)uK&jl+v@(mBh;cHaOi>T{ zu(sO=6V&|G_M4kTI#$=%eU>&CRvOckzS~lU$fpl44x>4_M)z=7yxVpg;zzz>nzfs^ zz8C9sUphYuy0$@U&;t6- zxdZl&+T>UG9Y+M!ATsyWE=)StMx=3P>34azpQg0B`rsqqz(^C3%bL<8{ukPQCEsJn zz8txFJHPN!_)=1.8.1 nbsphinx>=0.7.0 twine>=1.12.1 pre-commit>=2.7.1 -black>=20.0 +black>=20.8b1 pytest>=3.8.2 pytest-runner>=4.2 nbval>=0.9.6