search

srobo / tools

Student Robotics development helper scripts
4 stars 3 forks source link

Can't install from pypi source tarball #27

Closed kierdavis closed 5 years ago

kierdavis commented 5 years ago

I can't run python setup.py install in the tarball you can download from pypi here. This is annoying because this is the mechanism my system package manager (Nix) uses to build Python packages.

It looks like the cause is that calling the install command invokes the install_data command, which we override to involve calling build_sphinx; however the sources for the docs (including the conf.py mentioned in the error message) aren't included in this tarball.

Should the docs sources be included in this tarball? Or should we avoid calling build_sphinx in this scenario?

[nix-shell:/tmp/3]$ wget 'https://files.pythonhosted.org/packages/c1/09/0c2586b4740216a09c8098ba61b1a03301ffbb4b06cdcf5c9664ab730e0d/sr.tools-1.1.1.tar.gz'
--2019-09-11 08:39:47--  https://files.pythonhosted.org/packages/c1/09/0c2586b4740216a09c8098ba61b1a03301ffbb4b06cdcf5c9664ab730e0d/sr.tools-1.1.1.tar.gz
Resolving files.pythonhosted.org (files.pythonhosted.org)... 2a04:4e42:4::319, 151.101.17.63
Connecting to files.pythonhosted.org (files.pythonhosted.org)|2a04:4e42:4::319|:443... connected.
HTTP request sent, awaiting response... 200 OK
Length: 323428 (316K) [binary/octet-stream]
Saving to: ‘sr.tools-1.1.1.tar.gz’

sr.tools-1.1.1.tar.gz                                       100%[========================================================================================================================================>] 315.85K  --.-KB/s    in 0.05s   

2019-09-11 08:39:47 (6.60 MB/s) - ‘sr.tools-1.1.1.tar.gz’ saved [323428/323428]

(env) 
[nix-shell:/tmp/3]$ tar -xzf sr.tools-1.1.1.tar.gz 
(env) 
[nix-shell:/tmp/3]$ cd sr.tools-1.1.1/
(env) 
[nix-shell:/tmp/3/sr.tools-1.1.1]$ python setup.py install
zip_safe flag not set; analyzing archive contents...

<snip installation of dependencies...>

running install
running bdist_egg
running egg_info
writing sr.tools.egg-info/PKG-INFO
writing dependency_links to sr.tools.egg-info/dependency_links.txt
writing entry points to sr.tools.egg-info/entry_points.txt
writing namespace_packages to sr.tools.egg-info/namespace_packages.txt
writing requirements to sr.tools.egg-info/requires.txt
writing top-level names to sr.tools.egg-info/top_level.txt
reading manifest file 'sr.tools.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
writing manifest file 'sr.tools.egg-info/SOURCES.txt'
installing library code to build/bdist.linux-x86_64/egg
running install_lib
running build_py
creating build
creating build/lib
creating build/lib/sr
copying sr/__init__.py -> build/lib/sr
creating build/lib/sr/tools
copying sr/tools/__init__.py -> build/lib/sr/tools
copying sr/tools/budget.py -> build/lib/sr/tools
copying sr/tools/config.py -> build/lib/sr/tools
copying sr/tools/gerrit.py -> build/lib/sr/tools
copying sr/tools/environment.py -> build/lib/sr/tools
copying sr/tools/teamgit.py -> build/lib/sr/tools
copying sr/tools/spending.py -> build/lib/sr/tools
copying sr/tools/trac.py -> build/lib/sr/tools
creating build/lib/sr/tools/cli
copying sr/tools/cli/__init__.py -> build/lib/sr/tools/cli
copying sr/tools/cli/ide_list_repos.py -> build/lib/sr/tools/cli
copying sr/tools/cli/sp_line.py -> build/lib/sr/tools/cli
copying sr/tools/cli/inv_sync_asset.py -> build/lib/sr/tools/cli
copying sr/tools/cli/update.py -> build/lib/sr/tools/cli
copying sr/tools/cli/trac_depends_on.py -> build/lib/sr/tools/cli
copying sr/tools/cli/clone.py -> build/lib/sr/tools/cli
copying sr/tools/cli/inv_validate.py -> build/lib/sr/tools/cli
copying sr/tools/cli/document.py -> build/lib/sr/tools/cli
copying sr/tools/cli/trac_attach.py -> build/lib/sr/tools/cli
copying sr/tools/cli/budget_check.py -> build/lib/sr/tools/cli
copying sr/tools/cli/sd_serial.py -> build/lib/sr/tools/cli
copying sr/tools/cli/inv_history.py -> build/lib/sr/tools/cli
copying sr/tools/cli/inv_touch.py -> build/lib/sr/tools/cli
copying sr/tools/cli/inv_set_attr.py -> build/lib/sr/tools/cli
copying sr/tools/cli/budget_eval.py -> build/lib/sr/tools/cli
copying sr/tools/cli/inv_new_group.py -> build/lib/sr/tools/cli
copying sr/tools/cli/symbol_correct.py -> build/lib/sr/tools/cli
copying sr/tools/cli/sp_trac_compare.py -> build/lib/sr/tools/cli
copying sr/tools/cli/usb_key_serial.py -> build/lib/sr/tools/cli
copying sr/tools/cli/pcb_lint.py -> build/lib/sr/tools/cli
copying sr/tools/cli/budget_query.py -> build/lib/sr/tools/cli
copying sr/tools/cli/inv_mv.py -> build/lib/sr/tools/cli
copying sr/tools/cli/repolist.py -> build/lib/sr/tools/cli
copying sr/tools/cli/inv_show.py -> build/lib/sr/tools/cli
copying sr/tools/cli/ide_version.py -> build/lib/sr/tools/cli
copying sr/tools/cli/clone_team.py -> build/lib/sr/tools/cli
copying sr/tools/cli/trac_deps_add.py -> build/lib/sr/tools/cli
copying sr/tools/cli/pcb_to_thou.py -> build/lib/sr/tools/cli
copying sr/tools/cli/geda_hierpcb.py -> build/lib/sr/tools/cli
copying sr/tools/cli/inv_list_templates.py -> build/lib/sr/tools/cli
copying sr/tools/cli/ide_list_teams.py -> build/lib/sr/tools/cli
copying sr/tools/cli/budget_close.py -> build/lib/sr/tools/cli
copying sr/tools/cli/digikey.py -> build/lib/sr/tools/cli
copying sr/tools/cli/check_my_git.py -> build/lib/sr/tools/cli
copying sr/tools/cli/srweb_version.py -> build/lib/sr/tools/cli
copying sr/tools/cli/export_gerber.py -> build/lib/sr/tools/cli
copying sr/tools/cli/farnell.py -> build/lib/sr/tools/cli
copying sr/tools/cli/inv_edit.py -> build/lib/sr/tools/cli
copying sr/tools/cli/create_bom.py -> build/lib/sr/tools/cli
copying sr/tools/cli/create_order.py -> build/lib/sr/tools/cli
copying sr/tools/cli/inv_query.py -> build/lib/sr/tools/cli
copying sr/tools/cli/cam_serial.py -> build/lib/sr/tools/cli
copying sr/tools/cli/help.py -> build/lib/sr/tools/cli
copying sr/tools/cli/rs.py -> build/lib/sr/tools/cli
copying sr/tools/cli/__main__.py -> build/lib/sr/tools/cli
copying sr/tools/cli/budget_tree.py -> build/lib/sr/tools/cli
copying sr/tools/cli/mcv4b_part_code.py -> build/lib/sr/tools/cli
copying sr/tools/cli/trac_depgraph.py -> build/lib/sr/tools/cli
copying sr/tools/cli/make_purchase.py -> build/lib/sr/tools/cli
copying sr/tools/cli/sp_unspent.py -> build/lib/sr/tools/cli
copying sr/tools/cli/ledger.py -> build/lib/sr/tools/cli
copying sr/tools/cli/mouser.py -> build/lib/sr/tools/cli
copying sr/tools/cli/inv_list_assy_templates.py -> build/lib/sr/tools/cli
copying sr/tools/cli/sp_trac.py -> build/lib/sr/tools/cli
copying sr/tools/cli/inv_show_parent.py -> build/lib/sr/tools/cli
copying sr/tools/cli/trac_deps_rm.py -> build/lib/sr/tools/cli
copying sr/tools/cli/comp_calculate_league_matches.py -> build/lib/sr/tools/cli
copying sr/tools/cli/got_mcf.py -> build/lib/sr/tools/cli
copying sr/tools/cli/schedule_knockout.py -> build/lib/sr/tools/cli
copying sr/tools/cli/budget_diff.py -> build/lib/sr/tools/cli
copying sr/tools/cli/inv_new_asset.py -> build/lib/sr/tools/cli
copying sr/tools/cli/list_commands.py -> build/lib/sr/tools/cli
copying sr/tools/cli/price_graph.py -> build/lib/sr/tools/cli
copying sr/tools/cli/inv_findpart.py -> build/lib/sr/tools/cli
copying sr/tools/cli/stockcheck.py -> build/lib/sr/tools/cli
creating build/lib/sr/tools/inventory
copying sr/tools/inventory/__init__.py -> build/lib/sr/tools/inventory
copying sr/tools/inventory/inventory.py -> build/lib/sr/tools/inventory
copying sr/tools/inventory/query_parser.py -> build/lib/sr/tools/inventory
copying sr/tools/inventory/assetcode.py -> build/lib/sr/tools/inventory
copying sr/tools/inventory/luhn.py -> build/lib/sr/tools/inventory
copying sr/tools/inventory/query_ast.py -> build/lib/sr/tools/inventory
creating build/lib/sr/tools/bom
copying sr/tools/bom/__init__.py -> build/lib/sr/tools/bom
copying sr/tools/bom/geda.py -> build/lib/sr/tools/bom
copying sr/tools/bom/cachedfetch.py -> build/lib/sr/tools/bom
copying sr/tools/bom/threadpool.py -> build/lib/sr/tools/bom
copying sr/tools/bom/digikey.py -> build/lib/sr/tools/bom
copying sr/tools/bom/bom.py -> build/lib/sr/tools/bom
copying sr/tools/bom/farnell.py -> build/lib/sr/tools/bom
copying sr/tools/bom/rs.py -> build/lib/sr/tools/bom
copying sr/tools/bom/schem.py -> build/lib/sr/tools/bom
copying sr/tools/bom/distpart.py -> build/lib/sr/tools/bom
copying sr/tools/bom/mouser.py -> build/lib/sr/tools/bom
copying sr/tools/bom/parts_db.py -> build/lib/sr/tools/bom
copying sr/tools/cli/bom_header.html -> build/lib/sr/tools/cli
copying sr/tools/cli/document_prefix.tex -> build/lib/sr/tools/cli
copying sr/tools/cli/document_suffix.tex -> build/lib/sr/tools/cli
copying sr/tools/cli/latex-assets.zip -> build/lib/sr/tools/cli
copying sr/tools/cli/spend-template.yaml -> build/lib/sr/tools/cli
copying sr/tools/bom/component_lib.csv -> build/lib/sr/tools/bom
creating build/bdist.linux-x86_64
creating build/bdist.linux-x86_64/egg
creating build/bdist.linux-x86_64/egg/sr
creating build/bdist.linux-x86_64/egg/sr/tools
creating build/bdist.linux-x86_64/egg/sr/tools/bom
copying build/lib/sr/tools/bom/component_lib.csv -> build/bdist.linux-x86_64/egg/sr/tools/bom
copying build/lib/sr/tools/bom/parts_db.py -> build/bdist.linux-x86_64/egg/sr/tools/bom
copying build/lib/sr/tools/bom/mouser.py -> build/bdist.linux-x86_64/egg/sr/tools/bom
copying build/lib/sr/tools/bom/distpart.py -> build/bdist.linux-x86_64/egg/sr/tools/bom
copying build/lib/sr/tools/bom/schem.py -> build/bdist.linux-x86_64/egg/sr/tools/bom
copying build/lib/sr/tools/bom/rs.py -> build/bdist.linux-x86_64/egg/sr/tools/bom
copying build/lib/sr/tools/bom/farnell.py -> build/bdist.linux-x86_64/egg/sr/tools/bom
copying build/lib/sr/tools/bom/bom.py -> build/bdist.linux-x86_64/egg/sr/tools/bom
copying build/lib/sr/tools/bom/digikey.py -> build/bdist.linux-x86_64/egg/sr/tools/bom
copying build/lib/sr/tools/bom/threadpool.py -> build/bdist.linux-x86_64/egg/sr/tools/bom
copying build/lib/sr/tools/bom/cachedfetch.py -> build/bdist.linux-x86_64/egg/sr/tools/bom
copying build/lib/sr/tools/bom/geda.py -> build/bdist.linux-x86_64/egg/sr/tools/bom
copying build/lib/sr/tools/bom/__init__.py -> build/bdist.linux-x86_64/egg/sr/tools/bom
creating build/bdist.linux-x86_64/egg/sr/tools/inventory
copying build/lib/sr/tools/inventory/query_ast.py -> build/bdist.linux-x86_64/egg/sr/tools/inventory
copying build/lib/sr/tools/inventory/luhn.py -> build/bdist.linux-x86_64/egg/sr/tools/inventory
copying build/lib/sr/tools/inventory/assetcode.py -> build/bdist.linux-x86_64/egg/sr/tools/inventory
copying build/lib/sr/tools/inventory/query_parser.py -> build/bdist.linux-x86_64/egg/sr/tools/inventory
copying build/lib/sr/tools/inventory/inventory.py -> build/bdist.linux-x86_64/egg/sr/tools/inventory
copying build/lib/sr/tools/inventory/__init__.py -> build/bdist.linux-x86_64/egg/sr/tools/inventory
creating build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/spend-template.yaml -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/latex-assets.zip -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/document_suffix.tex -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/document_prefix.tex -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/bom_header.html -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/stockcheck.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/inv_findpart.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/price_graph.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/list_commands.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/inv_new_asset.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/budget_diff.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/schedule_knockout.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/got_mcf.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/comp_calculate_league_matches.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/trac_deps_rm.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/inv_show_parent.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/sp_trac.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/inv_list_assy_templates.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/mouser.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/ledger.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/sp_unspent.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/make_purchase.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/trac_depgraph.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/mcv4b_part_code.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/budget_tree.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/__main__.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/rs.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/help.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/cam_serial.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/inv_query.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/create_order.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/create_bom.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/inv_edit.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/farnell.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/export_gerber.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/srweb_version.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/check_my_git.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/digikey.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/budget_close.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/ide_list_teams.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/inv_list_templates.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/geda_hierpcb.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/pcb_to_thou.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/trac_deps_add.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/clone_team.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/ide_version.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/inv_show.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/repolist.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/inv_mv.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/budget_query.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/pcb_lint.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/usb_key_serial.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/sp_trac_compare.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/symbol_correct.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/inv_new_group.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/budget_eval.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/inv_set_attr.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/inv_touch.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/inv_history.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/sd_serial.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/budget_check.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/trac_attach.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/document.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/inv_validate.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/clone.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/trac_depends_on.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/update.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/inv_sync_asset.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/sp_line.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/ide_list_repos.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/cli/__init__.py -> build/bdist.linux-x86_64/egg/sr/tools/cli
copying build/lib/sr/tools/trac.py -> build/bdist.linux-x86_64/egg/sr/tools
copying build/lib/sr/tools/spending.py -> build/bdist.linux-x86_64/egg/sr/tools
copying build/lib/sr/tools/teamgit.py -> build/bdist.linux-x86_64/egg/sr/tools
copying build/lib/sr/tools/environment.py -> build/bdist.linux-x86_64/egg/sr/tools
copying build/lib/sr/tools/gerrit.py -> build/bdist.linux-x86_64/egg/sr/tools
copying build/lib/sr/tools/config.py -> build/bdist.linux-x86_64/egg/sr/tools
copying build/lib/sr/tools/budget.py -> build/bdist.linux-x86_64/egg/sr/tools
copying build/lib/sr/tools/__init__.py -> build/bdist.linux-x86_64/egg/sr/tools
copying build/lib/sr/__init__.py -> build/bdist.linux-x86_64/egg/sr
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/bom/parts_db.py to parts_db.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/bom/mouser.py to mouser.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/bom/distpart.py to distpart.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/bom/schem.py to schem.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/bom/rs.py to rs.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/bom/farnell.py to farnell.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/bom/bom.py to bom.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/bom/digikey.py to digikey.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/bom/threadpool.py to threadpool.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/bom/cachedfetch.py to cachedfetch.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/bom/geda.py to geda.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/bom/__init__.py to __init__.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/inventory/query_ast.py to query_ast.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/inventory/luhn.py to luhn.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/inventory/assetcode.py to assetcode.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/inventory/query_parser.py to query_parser.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/inventory/inventory.py to inventory.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/inventory/__init__.py to __init__.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/stockcheck.py to stockcheck.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/inv_findpart.py to inv_findpart.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/price_graph.py to price_graph.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/list_commands.py to list_commands.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/inv_new_asset.py to inv_new_asset.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/budget_diff.py to budget_diff.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/schedule_knockout.py to schedule_knockout.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/got_mcf.py to got_mcf.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/comp_calculate_league_matches.py to comp_calculate_league_matches.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/trac_deps_rm.py to trac_deps_rm.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/inv_show_parent.py to inv_show_parent.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/sp_trac.py to sp_trac.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/inv_list_assy_templates.py to inv_list_assy_templates.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/mouser.py to mouser.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/ledger.py to ledger.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/sp_unspent.py to sp_unspent.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/make_purchase.py to make_purchase.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/trac_depgraph.py to trac_depgraph.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/mcv4b_part_code.py to mcv4b_part_code.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/budget_tree.py to budget_tree.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/__main__.py to __main__.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/rs.py to rs.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/help.py to help.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/cam_serial.py to cam_serial.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/inv_query.py to inv_query.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/create_order.py to create_order.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/create_bom.py to create_bom.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/inv_edit.py to inv_edit.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/farnell.py to farnell.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/export_gerber.py to export_gerber.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/srweb_version.py to srweb_version.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/check_my_git.py to check_my_git.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/digikey.py to digikey.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/budget_close.py to budget_close.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/ide_list_teams.py to ide_list_teams.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/inv_list_templates.py to inv_list_templates.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/geda_hierpcb.py to geda_hierpcb.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/pcb_to_thou.py to pcb_to_thou.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/trac_deps_add.py to trac_deps_add.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/clone_team.py to clone_team.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/ide_version.py to ide_version.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/inv_show.py to inv_show.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/repolist.py to repolist.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/inv_mv.py to inv_mv.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/budget_query.py to budget_query.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/pcb_lint.py to pcb_lint.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/usb_key_serial.py to usb_key_serial.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/sp_trac_compare.py to sp_trac_compare.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/symbol_correct.py to symbol_correct.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/inv_new_group.py to inv_new_group.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/budget_eval.py to budget_eval.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/inv_set_attr.py to inv_set_attr.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/inv_touch.py to inv_touch.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/inv_history.py to inv_history.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/sd_serial.py to sd_serial.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/budget_check.py to budget_check.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/trac_attach.py to trac_attach.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/document.py to document.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/inv_validate.py to inv_validate.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/clone.py to clone.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/trac_depends_on.py to trac_depends_on.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/update.py to update.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/inv_sync_asset.py to inv_sync_asset.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/sp_line.py to sp_line.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/ide_list_repos.py to ide_list_repos.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/cli/__init__.py to __init__.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/trac.py to trac.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/spending.py to spending.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/teamgit.py to teamgit.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/environment.py to environment.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/gerrit.py to gerrit.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/config.py to config.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/budget.py to budget.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/tools/__init__.py to __init__.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/sr/__init__.py to __init__.cpython-37.pyc
installing package data to build/bdist.linux-x86_64/egg
running install_data
running build_sphinx

Application error:
config directory doesn't contain a conf.py file (.)
(env) 
[nix-shell:/tmp/3/sr.tools-1.1.1]$ ls
build  MANIFEST.in  PKG-INFO  README.rst  setup.cfg  setup.py  sr  sr.tools.egg-info
(env) 
[nix-shell:/tmp/3/sr.tools-1.1.1]$
PeterJCLaw commented 5 years ago

From what I can tell from the source and recall from the original discussions around the packaging of these tools, the idea is that you get man pages along with with the tooling when you install it. I'm not actually sure if that works (though I'm pretty sure that it did work at one point) currently; it's possible something in the way I've been pushing packages to PyPI is missing some data.

Given that precedent though, I think it would be reasonable to include the docs in the .tar.gz distribution, certainly it would make sense that if you want the source archive then you probably want the docs too.

My understanding of Python packaging is limited, though I think this is something we can achieve by adding something to the MANIFEST.in file?

Whatever the route to including the docs in the archive, is this something you'd be interested in working on fixing @kierdavis?

kierdavis commented 5 years ago

Yeah, I'm happy to work on this - I was mainly looking for input on which approach to take. I also think MANIFEST.in is the best place to start.

kierdavis commented 5 years ago

@PeterJCLaw Fixed in #28.