romanz/trezor-agent

Trezor agent installation instructions confusing

doolio opened this issue · 2 comments

Is it trezor_agent or trezor-agent? Note the underscore vs the hyphen. I believe it is the latter.

trezor-agent-install-instructions

Step 3 above suggests using $ pip3 install trezor_agent but PyPI suggests $ pip 3 install trezor-agent. This link also uses trezor_agent but is any case re-directed to trezor-agent.

There is reference to trezor_agent here, here and here.

Also, is this line $ pip3 install Cython hidapi necessary considering trezor[hidapi] is required in the trezor agent setup.py and you don't suggest it if installing from this repository. I believe Cython (or cython and/or cython3 to be explicit?) is a pre-requisite of trezor so is it not less confusing to list it as an OS dependency.

romanz commented

Thanks!
It's possible to install it both using pip install trezor_agent & pip install trezor-agent.
I'll modify the docs to use trezor-agent for consistency.

doolio commented

It's possible to install it both using pip install trezor_agent & pip install trezor-agent

Interesting, why is that?

I'll modify the docs to use trezor-agent for consistency.

Looking at this again because I wanted to see if it was necessary to update the following line:

name='trezor_agent',

It seems not as despite the PyPI page pointing to https://pypi.org/project/trezor-agent the source distribution visible on this page uses trezor_agent so I think on further reflection the best think would have been to update the PyPI project page to be https://pypi.org/project/trezor_agent and to use trezor_agent throughout that page. This keep it consistent with your other hardware device agent packages on PyPI - they all use an underscore except for onlykeep-agent but it is at least consistent to always use a hypen everywhere.