bash: pdoc: command not found

[wq2012]

Expected Behavior

On a Mac or Linux machine,

$ pip3 install pdoc3
$ pdoc --html pdoc

produces documentation.

Actual Behavior

Second command yields:

$ bash: pdoc: command not found

Steps to Reproduce

1. On a Linux or Mac machine, open terminal
2. Type the commands
3. Read the results

Additional info

• pdoc version:

Python 3.5.4rc1 (default, Jul 25 2017, 08:53:34)
[GCC 7.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import pdoc
>>> print(pdoc.__version__)
0.5.1

Suggestion

Add __main__.py file such that users can at least do:

$ python3 -m pdoc ...

[kernc]

I'm sorry, I can't reproduce the issue:

$ pip3 install pdoc3
Collecting pdoc3
...
Successfully installed MarkupSafe-1.1.0 mako-1.0.7 markdown-3.0.1 pdoc3-0.5.1

$ which pip3
/usr/bin/pip3

$ pip3 freeze | grep pdoc
pdoc3==0.5.1

$ which pdoc
/home/user/.local/bin/pdoc

$ which pdoc3
/home/user/.local/bin/pdoc3

$ cat $(which pdoc)

#!/usr/bin/python3
# -*- coding: utf-8 -*-
import sys

from pdoc.cli import main

if __name__ == '__main__':
    sys.exit(main())

As setup.py does specify console scripts, it should be up to setuptools/pip to wire up the executables.

pdoc/setup.py

Lines 39 to 44 in e7868e2

	entry_points={
	"console_scripts": [
	"pdoc = pdoc.cli:main",
	"pdoc3 = pdoc.cli:main",
	],
	},

Have you tried updating pip and setuptools? Do you have any other ideas?

Add __main__.py file such that users can at least do

Would you care to add __main__.py in a pull request?

[wq2012]

Updating pip3 didn't seem to resolve the issue for me. Not sure why.

Anyway, adding __main__.py should make it easier. I've sent pull request. Hope we can include it in the next PyPI release.

[kernc]

Thanks! It should be released as pdoc3 0.5.2 within a few days. 👍

Updating pip3 didn't seem to resolve the issue for me. Not sure why.

Should you later eventually figure out what was it in your environment, blocking the creation/discovery of executables, I'll appreciate a notice about it.