Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.debian.maint.python > #7805 > unrolled thread

dh-python (pybuild + dh_py*) documentation

Back to article view | Back to linux.debian.maint.python

Contents

  dh-python (pybuild + dh_py*) documentation Piotr Ożarowski <piotr@debian.org> - 2015-10-26 12:40 +0100
    Re: dh-python (pybuild + dh_py*) documentation Raphael Hertzog <hertzog@debian.org> - 2015-10-26 18:30 +0100
      Re: dh-python (pybuild + dh_py*) documentation Barry Warsaw <barry@debian.org> - 2015-10-27 20:20 +0100
      Re: dh-python (pybuild + dh_py*) documentation Piotr Ożarowski <piotr@debian.org> - 2015-10-28 14:10 +0100
        Re: dh-python (pybuild + dh_py*) documentation Nikolaus Rath <Nikolaus@rath.org> - 2015-10-28 17:40 +0100
          Re: dh-python (pybuild + dh_py*) documentation Piotr Ożarowski <piotr@debian.org> - 2015-10-28 18:00 +0100
            Re: dh-python (pybuild + dh_py*) documentation Barry Warsaw <barry@debian.org> - 2015-10-28 19:30 +0100
    Re: dh-python (pybuild + dh_py*) documentation Matthias Klose <doko@debian.org> - 2015-10-28 13:30 +0100
      Re: dh-python (pybuild + dh_py*) documentation Brian May <bam@debian.org> - 2015-10-28 22:50 +0100

#7805 — dh-python (pybuild + dh_py*) documentation

there are manpages: pybuild¹, dh_python3² / dh_python2³ / dh_pypy⁴
there's a wiki page⁵ with examples, there's even
/usr/share/doc/dh-python/README.PyDist⁶ and a talk⁷ about pybuild during
DebConf... but people still tell me dh-python's documentation sucks
so...

How can I improve it? Do you need more detailed description of options?
Do you need more examples? Or maybe I should hide most of options, the
"corner case" ones? I focus on making things work out of the box, if
possible, and make it very customizable so that weird corner cases are
possible as well - this means there are a lot of options, is this the
problem?

Can you be more specific about what's missing?

[¹] http://anonscm.debian.org/cgit/dh-python/dh-python.git/tree/pybuild.rst
[²] http://anonscm.debian.org/cgit/dh-python/dh-python.git/tree/dh_python3.rst
[³] http://anonscm.debian.org/cgit/dh-python/dh-python.git/tree/dh_python2.rst
[⁴] http://anonscm.debian.org/cgit/dh-python/dh-python.git/tree/dh_pypy.rst
[⁵] https://wiki.debian.org/Python/Pybuild
[⁶] http://anonscm.debian.org/cgit/dh-python/dh-python.git/tree/pydist/README.PyDist
[⁷] http://caesar.acc.umu.se/pub/debian-meetings/2014/debconf14/webm/introduction_to_pybuild_and_Python_packaging.webm 
-- 
Piotr Ożarowski                         Debian GNU/Linux Developer
www.ozarowski.pl          www.griffith.cc           www.debian.org
GPG Fingerprint: 1D2F A898 58DA AF62 1786 2DF7 AEF6 F1A2 A745 7645

[toc] | [next] | [standalone]

#7807

Hi Piotr,

On Mon, 26 Oct 2015, Piotr Ożarowski wrote:
> How can I improve it? Do you need more detailed description of options?
> Do you need more examples? Or maybe I should hide most of options, the
> "corner case" ones? I focus on making things work out of the box, if
> possible, and make it very customizable so that weird corner cases are
> possible as well - this means there are a lot of options, is this the
> problem?
> 
> Can you be more specific about what's missing?

I for one lack a high level presentation of how the various bits work together
and a clear description of the "magic" behind each tool.

For instance, dh_python2 explains that it tries to translate Python
dependencies into Debian dependencies but it's not clear that it needs
the corresponding packages installed (so it's not clear that for this
to work you have to add something to Build-Depends).

Cheers,
-- 
Raphaël Hertzog ◈ Debian Developer

Support Debian LTS: http://www.freexian.com/services/debian-lts.html
Learn to master Debian: http://debian-handbook.info/get/

[toc] | [prev] | [next] | [standalone]

#7811

On Oct 26, 2015, at 06:28 PM, Raphael Hertzog wrote:

>I for one lack a high level presentation of how the various bits work together
>and a clear description of the "magic" behind each tool.

I agree with this.  When you know where to look, the documentation is actually
quite good.  Maybe there are a few things here or there that could be filled
in or improved, but it's all generally there.

The problem is that when things don't build as expected, it's difficult to
understand which magical piece is misbehaving.

Cheers,
-Barry

[toc] | [prev] | [next] | [standalone]

#7813

[Multipart message — attachments visible in raw view] — view raw

> > Can you be more specific about what's missing?
> 
> I for one lack a high level presentation of how the various bits work together

here's what I got so far (I wanted to provide it as
/usr/share/doc/dh-python/README). I stopped working on it because now I
have to prove dh-python is not responsible for maintainers that override
dh_auto_install and rm egg-info or new "features" in python3.5
-- 
evil general Piotr (Brutus: or is it caezar now?)

[toc] | [prev] | [next] | [standalone]

#7814

On Oct 28 2015, Piotr Ożarowski <piotr@debian.org> wrote:
>> > Can you be more specific about what's missing?
>> 
>> I for one lack a high level presentation of how the various bits work together
>
> here's what I got so far (I wanted to provide it as
> /usr/share/doc/dh-python/README).

Looks great. That would have made my start with pybuild and dh_python
much easier :-).

> I stopped working on it because now I
> have to prove dh-python is not responsible for maintainers that override
> dh_auto_install and rm egg-info or new "features" in python3.5

I don't understand that sentence.


Best,
-Nikolaus

-- 
GPG encrypted emails preferred. Key id: 0xD113FCAC3C4E599F
Fingerprint: ED31 791B 2C5C 1613 AF38 8B8A D113 FCAC 3C4E 599F

             »Time flies like an arrow, fruit flies like a Banana.«

[toc] | [prev] | [next] | [standalone]

#7815

> > I stopped working on it because now I
> > have to prove dh-python is not responsible for maintainers that override
> > dh_auto_install and rm egg-info or new "features" in python3.5
> 
> I don't understand that sentence.

it's just my rant of the day. Each day I choose a victim and enable
Piotr's evil mode. Yesterday it was Barry, today it's Matthias.

Usually I focus on cursing distutils but if there are no new features
to curse, I have to be more creative (especially when
distutils/setuptools author^W maintainer is very helpful in providing
new workarounds and nasty hacks, so blame him ;)
-- 
Piotr Ożarowski                         Debian GNU/Linux Developer
www.ozarowski.pl          www.griffith.cc           www.debian.org
GPG Fingerprint: 1D2F A898 58DA AF62 1786 2DF7 AEF6 F1A2 A745 7645

[toc] | [prev] | [next] | [standalone]

#7816

On Oct 28, 2015, at 05:59 PM, Piotr Ożarowski wrote:

>Each day I choose a victim and enable Piotr's evil mode.

Beware the Eye of Piotr.

:)

-Barry

[toc] | [prev] | [next] | [standalone]

#7812

On 26.10.2015 12:36, Piotr Ożarowski wrote:
> there are manpages: pybuild¹, dh_python3² / dh_python2³ / dh_pypy⁴
> there's a wiki page⁵ with examples, there's even
> /usr/share/doc/dh-python/README.PyDist⁶ and a talk⁷ about pybuild during
> DebConf... but people still tell me dh-python's documentation sucks
> so...

talks and mailing list discussions are forgotten.

> How can I improve it? Do you need more detailed description of options?
> Do you need more examples? Or maybe I should hide most of options, the
> "corner case" ones? I focus on making things work out of the box, if
> possible, and make it very customizable so that weird corner cases are
> possible as well - this means there are a lot of options, is this the
> problem?
>
> Can you be more specific about what's missing?

Agreed on the high level overview.  Maybe somebody could come up with a table of 
contents, and then people can start filling that? There was at least one comment 
from a book author ;)

I'd like to see a section with examples too, maybe even referencing particular 
packages, which show good practice for a given use case, or which demonstrate 
some feature.

Please don't hide things.  When I see something in a build log, I'd like to be 
able to reproduce it.  pybuild writes these "I: ..." messages, but these are 
still incomplete. It would be good to see directory changes and other side 
effects like setting of env vars and written config files as well.  I found 
these missing while looking at #803242. However asking you on irc usually helps 
;)  Having these build logs a bit more verbose won't hurt.

The #803242 is exposed by having packages built with multiple python versions, 
so maybe it would have been found by a testsuite, or some autopkg tests.  A 
testsuite for the pybuild features would be very nice to have.

Matthias

[toc] | [prev] | [next] | [standalone]

#7817

Matthias Klose <doko@debian.org> writes:

> I'd like to see a section with examples too, maybe even referencing particular 
> packages, which show good practice for a given use case, or which demonstrate 
> some feature.

Examples of how to override dh_auto_test to run custom tests would be
good. It seems to be the most frequent thing I need to override.

Also examples of how to replace javascript files and have them
redirected to the packaged files (e.g. libjs-jquery) - this also seems
to be a common problem.

The other common problem I have is Django applications that put template
files under the python directory - which triggers a lintian warning
about putting the files under /usr/lib instead of /usr/share
(image-file-in-usr-lib). Not sure if we care about this even or if
fixing this could be another example.

As a side note, been thinking of requesting another lintian check - for
python3-* packages that Depends on ${python:Depends} instead of
${python3:Depends} - seems to be a common problem I encounter.

(apologies if any of these have already been done, don't have time to
check now.)
-- 
Brian May <bam@debian.org>

[toc] | [prev] | [standalone]

Back to top | Article view | linux.debian.maint.python

csiph-web