[WAS: Re: Review/sponsorship of osmalchemy package] md , rst, txt, html, ...

2016-09-27 Thread Jerome BENOIT 
Hello Forum,

On 27/09/16 23:41, Thomas Goirand wrote:
> debian/docs:
> 
> * It looks like the README.rst could be transformed into .html using
> sphinx. Could you do that? It'd look a lot nicer.


Some software comes with a README.md, README.rst, ...
which are the same version of a text but written in different format:
Must we pick up one ? If so, which one ? or may we transform one of them
in txt (or html) ?

Thanks,
Jerome

Re: Review/sponsorship of osmalchemy package

2016-09-27 Thread Thomas Goirand 
On 09/12/2016 03:39 PM, Dominik George wrote:
> Hi,
> 
> I would like to ask for review and sponsorship of the osmalchemy package.
> 
> It can be found in the usual place at:
> git.debian.org:/git/python-modules/packages/osmalchemy.git
> 
> The package can be build with gbp using pristine-tar. It appears to be
> lintian-clean, apart from a missing upstream changelog (which upstream,
> i.e. me, myself and I, will fix in a future release ;)).
> 
> OSMAlchemy will be used in several projects that will run on Debian;
> it was also feaured at the Python Unconference in Germany last weekend
> and many people like it and would like to use it, so adding it to Debian
> seems legit (it has also a quite low impact on the repo, as it has only
> few dependencies, so nothing bad to expect there).
> 
> Thanks in advance for looking at the package,
> Nik

Here's my comments.

debian/changelog:
=
* Please just write "Initial debian release".

debian/control:
===
* Please remove "X-Python3-Version: >= 3.2". Even Jessie has Python 3.2,
so we really don't need to set such lower bound.

* Please set "Priority: extra" and not optional.

* You may want to run "wrap-and-sort -t -a" to clean-up your
debian/control fields (YMMV).

debian/copyright:
=
* There's multiple MIT licenses. Therefore, the most common MIT license,
we call it "Expat" in Debian (not sure why, but it's like that...). So
please replace MIT by Expat.

debian/docs:

* It looks like the README.rst could be transformed into .html using
sphinx. Could you do that? It'd look a lot nicer.

debian/python3-osmalchemy.lintian-overrides:

* Why do you think you need such a file? The issue is there, it's not a
false positive, so just leave lintian complain. It gives a warning, not
a hard error, so that's fine.

Everything else looked ok to me, though it was only a quick look...

Cheers,

Thomas Goirand (zigo)

Upstream build system, Sphinx autodoc, Python import path

2016-09-27 Thread Ben Finney 
Howdy all,

What advice can we give to upstream for their build system, so that
in a Debian build environment the Sphinx ‘autodoc’ can import upstream's
code modules?

Our wiki page on Library Style Guide advises the Debian packaging
override the Python import path:

If you need to build the Sphinx documentation (usually from .rst or
.md files), add:

override_dh_auto_build:
dh_auto_build
PYTHONPATH=. sphinx-build -N -bhtml docs/ build/html # HTML 
generator
PYTHONPATH=. sphinx-build -N -bman docs/ build/man # Manpage 
generator



This is surely not ideal, though. Better would be to not need
‘PYTHONPATH’ override at all, and just call the build program.

What information do our build tools look for, and what variables are
set, when running upstream's build system?

What can we advise to upstream so their build system will work correctly
in our build environment *without* that override in every Sphinx-using
package?

-- 
 \ “For a sentimentalist is simply one who desires to have the |
  `\luxury of an emotion without paying for it.” —Oscar Wilde, _De |
_o__) Profundis_, 1897 |
Ben Finney