The narrow road to the deep North of version 1.0 about pyvips HOT 19 CLOSED

pypy seems to work now too.

from pyvips.

Benchmark! Here's the old one:

john@kiwi:~/GIT/libvips/test (master)$ ./test_all.py 
...................................................................................................................................................................................
----------------------------------------------------------------------
Ran 179 tests in 85.600s

OK
memory: high-water mark 126.94 MB

And this new one:

john@kiwi:~/GIT/pyvips (master)$ nosetests --logging-level=WARNING
...................................................................................................................................................................................
----------------------------------------------------------------------
Ran 179 tests in 67.818s

OK
memory: high-water mark 126.94 MB

So a bit quicker, but it's not dramatic.

from pyvips.

The py3 branch is supposed to be for python3 compat experiments

from pyvips.

Kleis has fixed all the py3 issues!

from pyvips.

Sample docs:

http://www.rollthepotato.net/~john/html/

from pyvips.

Sample docs with a Read the Docs theme:
https://t0.nl/pyvips/

Let me know if you like it. The branch is located here.

from pyvips.

Hey that looks nice! Sure, let's switch, I'll merge your branch.

It would be great to be able to get sphinx to make a method index. The vimage page (for example) has several 100 methods listed, but no overview, so you have to scroll all the time. I've not been able to find out how to add items to the toc for methods :(

from pyvips.

OK, I've set up gh-pages and revised the README. I'm inclined to call this 1.0 and skip the last two things on the checklist for now.

What do you think? Shall I pop it on pypi?

from pyvips.

I think it's stable enough for release on PyPI. Let's ship it

from pyvips.

I tried to improve the vimage page (by adding a TOC), see: https://t0.nl/pyvips/vimage.html
(the branch is located here)

Only the autogenerated methods needs to be added on that page. I've added the add method as example (at the bottom). I think it would be nice if everything is alphabetical.

from pyvips.

Oh nice, merged! I'll see if I can list the autogen methods alphabetically.

from pyvips.

I found an extension to generate the toc automatically, it seems to work for the main methods at least.

I'll generate a toc for the auto methods.

from pyvips.

Seems to work!

https://jcupitt.github.io/pyvips/index.html

I've put vimage back all on to one page so you can ^F and search for stuff, hope that's OK.

from pyvips.

Nice! I think it doesn't matter that everything is on one page, the only thing is that it's quite large page now.

It seems that the autoautosummary extension can include attributes. Can we also use that? (for example bands, width, height, etc.)

These methods don't have a summary, by the way:

get_offset
get_pspec
get_scale
imageize

I think we can exclude imageize if we prefix it with an underscore.

from pyvips.

Yes, those need to be tagged as deprecated, get_value and set_value too.

from pyvips.

OK, deprecated and hidden! It's looking better!

You're right, we should mark up attributes like width / height / etc. too. These probably need to be added by hand somewhere, but I think I'm out of time this weekend.

from pyvips.

Ahem, I found some time, it's on pypi!

https://pypi.python.org/pypi/pyvips

I'll close this and open new issues for the remaining items.

I think we've done a great job, Kleis! I intend to have a beer tonight. Cheers!

from pyvips.

Nice! 🍻

I tried to minimize the size of the vimage page by collapsing all methods by default. When you click on the method or when a anchor is defined in the URL it will expand it's content. See for a live demo here: https://t0.nl/pyvips/vimage.html

What do you think? Branch is located here.

If there is now too many information hidden I could try to make everything that comes after the word Example: collapsible (the summary should than stay visible).

from pyvips.

I've made only the method examples collapsible (the summary is still visible) in this version: https://t0.nl/pyvips2/vimage.html

Branch is located here.

It looks neater now, and the height of the vimage page is reduced by 72089 pixels (we now have to scroll less).

from pyvips.