[Qgis-psc] Python cookbook revision final report

[Alessandro Pasotti]

On Fri, Apr 17, 2020 at 3:40 PM Anita Graser <anitagraser at gmx.at> wrote:

> Awesome work, Ale!
>
> I assume it would be good to announce the new revised cookbook on
> blog.qgis.org?
>
> Do you want to write the blog post or should I prepare something based on
> your report?
>
> Regards,
>
> Anita
>

Hi Anita,

feel free to cut&paste from my report, I wrote it with the idea that some
paragraphs could have been useful for a blog post too.

I didn't mention in the report that I also backported it to 3.10
documentation.


Thank you!


> On 06.04.2020 16:14, Tim Sutton wrote:
>
> Wow - absolutely awesome Ale, and thank you so much for the additional
> effort you donated!
>
> Regards
>
> Tim
>
> On 6 Apr 2020, at 13:59, Alessandro Pasotti <apasotti at gmail.com> wrote:
>
> Hi all,
>
> first of all I would like to thank you all and all the QGIS sponsors
> and donors together with the documentation team for making this review
> process possible. I also wish to thank Martin Dobias for his help in
> spotting out an issue in one snippet with Plugin Layers
>
> To be completely honest, this task took me quite a bit more time than
> planned, so consider the additional time that I spent on it as a
> voluntary contribution by me (or QCooperative as you prefer :)
>
> As it was initially planned I was able to review all the code snippets
> in the cookbook and to put them under automated test in CI.
> Before I started there were 62 tests over ~300 code snippets, we are
> now at 303 tested snippets (302 on 3.10). Despite my efforts (where I
> probably lost most of my time) I had to skip a handful of snippets
> that were running perfectly well when tested manually but failing on
> the doctest CI process:
> - task manager tests (1 out of 3 on master, 2 out of 3 on 3.10)
> - all standalone application tests (because the mocked application is
> already started globally and it cannot be re-initialized)
>
> Note that for a few of the most complex snippets the test coverage is
> not 100% because the test does not really cover all execution paths.
>
> I didn't have time to go through a reorganization of the text contents
> but I did quickly read all the texts and I made some small
> modifications to update the contents where the API had substantially
> changed from the original texts.
>
> A few snippets had to be updated because of changes in the QGIS API or
> because of the deprecation of a the methods, CRS handling in
> particular due to the proj6 switch, but there were also other places
> where I had to make small changes.
>
> I've found just 1 syntax error in the whole code!
>
> The changes have been backported to the 3.10 branch.
>
> Last but not least, I couldn't resist to add a few sections and to do
> an more in-depth review of the server Python cookbook section, I
> reorganized the material about plugins and I added snippets and short
> introductory texts about the new modules and OGC APIs architecture.
>
> A final personal consideration:
>
> I think that the cookbook is a great source of information, not only
> for PyQgis begginers or plugin developers but also for C++ developers:
> it contains a lot of information about the internals of the QGIS API
> that you cannot really find anywhere else.
>
> It could probably benefit from a reorganization of a few sections but
> it is already a great resource as it is.
>
> Cheers
>
> --
> Alessandro Pasotti
> w3:   www.itopen.it
> _______________________________________________
> Qgis-psc mailing list
> Qgis-psc at lists.osgeo.org
> https://lists.osgeo.org/mailman/listinfo/qgis-psc
>
>
> —
>
>
>
>
>
>
>
>
> *Tim Sutton*
>
> *Co-founder:* Kartoza
> *Ex Project chair:* QGIS.org
>
> Visit http://kartoza.com to find out about open source:
>
> Desktop GIS programming services
> Geospatial web development
> GIS Training
> Consulting Services
>
> *Skype*: timlinux
> *IRC:* timlinux on #qgis at freenode.net
>
> I'd love to connect. Here's my calendar link
> <https://calendly.com/timlinux> to make finding time easy.
>
>
> _______________________________________________
> Qgis-psc mailing listQgis-psc at lists.osgeo.orghttps://lists.osgeo.org/mailman/listinfo/qgis-psc
>
>

-- 
Alessandro Pasotti
w3:   www.itopen.it
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-psc/attachments/20200417/85507aa6/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: KartozaNewLogoThumbnail.jpg
Type: image/jpeg
Size: 6122 bytes
Desc: not available
URL: <http://lists.osgeo.org/pipermail/qgis-psc/attachments/20200417/85507aa6/attachment.jpg>