samples directory contains mystifying code
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
launchpadlib |
Triaged
|
Low
|
Unassigned |
Bug Description
The example code in the samples/ directory is effectively undocumented, and not self-explanatory. Also, sample-
Steps to reproduce:
I installed launchpadlib from a trunk branch today:
$ bzr branch lp:launchpadlib
$ cd launchpadlib
$ sudo python setup.py install
Looking for example code, I entered the samples/ directory:
$ cd samples/
$ ls *.py
commercial-
lpapi.py
nopriv-api.py
_pythonpath.py
sample-
$
I opened up sample-
$ ./sample-
Login as '<email address hidden>' in your browser.
Press <Enter> when done.
### it waited for input here ###
Hmmm. It didn't say a password to use, but I tried logging into http://
<matsubara> kfogel: test@canonical doesn't exist on lp.net or
staging.l.n. it's sample data for the development environment.
<matsubara> kfogel: that sample will only work if you have the full
LP source code available and the devel environment up and running.
I hit ^C...
C-c C-cTraceback (most recent call last):
File "./sample-
raw_input()
KeyboardInterrupt
$
...and started looking at the other scripts. None were documented, though some had similar Python command interpreter transcripts at the top. Later I tried sample-
So:
1. Can the sample scripts be documented?
2. A user of launchpadlib is not necessarily likely to also be a developer of Launchpad itself, so nothing should depend on the '<email address hidden>' user being available. I think only sample-
Changed in launchpadlib: | |
importance: | Undecided → Medium |
status: | New → Triaged |
Changed in launchpadlib: | |
importance: | Medium → Low |