[tahoe-lafs-trac-stream] [tahoe-lafs] #1659: setuptools/easy_install/pip-installed package lacks documentation

[tahoe-lafs]

#1659: setuptools/easy_install/pip-installed package lacks documentation
--------------------------+----------------------------
     Reporter:  nejucomo  |      Owner:  nobody
         Type:  defect    |     Status:  new
     Priority:  major     |  Milestone:  undecided
    Component:  unknown   |    Version:  1.9.0
   Resolution:            |   Keywords:  packaging pypi
Launchpad Bug:            |
--------------------------+----------------------------

Comment (by zooko):

 Replying to [comment:7 nejucomo]:
 >
 > * It may use the wrong path format for all platforms...  I suspect it
 should use `distutils.util.convert_path()` somewhere.
 > * There's no test code.  Testing build/install scaffolding is difficult!

 We have a (kludgey) way to test such things. Here is the output on
 buildbot:

 A test of {{{['python', '-c', "import glob, os, subprocess, sys;
 os.mkdir('egginstalldir'); tahoe_egg = glob.glob(os.path.join('dist',
 '*.egg'))[0]; sys.exit(subprocess.call(['easy_install', '-d',
 'egginstalldir', tahoe_egg]))"]}}}:

 https://tahoe-lafs.org/buildbot-tahoe-
 lafs/builders/Kyle%20OpenBSD%20amd64/builds/235/steps/install-to-
 egg/logs/stdio

 A test of {{{['python', '-c', "import subprocess,
 sys;sys.exit(subprocess.call([sys.executable, 'setup.py', 'install',
 '--single-version-externally-managed', '--record=record.txt', '--prefix',
 'prefixinstalldir']))"]}}}:

 https://tahoe-lafs.org/buildbot-tahoe-
 lafs/builders/Kyle%20OpenBSD%20amd64/builds/235/steps/install-to-
 prefix/logs/stdio

 In both cases, they are followed by executing the unit tests from within
 the installed location:

 https://tahoe-lafs.org/buildbot-tahoe-
 lafs/builders/Kyle%20OpenBSD%20amd64/builds/235/steps/test-from-egg

 and

 https://tahoe-lafs.org/buildbot-tahoe-
 lafs/builders/Kyle%20OpenBSD%20amd64/builds/235/steps/test-from-prefixdir

 So to test that the docs are installed correctly, I guess we could add
 another Buildbot BuildStep which runs after the install and before the
 unit-tests-run-from-installed, which just asserts that the right files are
 in place.

 Nathan: interested in contributing such a test?

-- 
Ticket URL: <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1659#comment:10>
tahoe-lafs <https://tahoe-lafs.org>
secure decentralized storage