Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Trezor agent installation instructions confusing #342

Closed
doolio opened this issue Dec 15, 2020 · 2 comments
Closed

Trezor agent installation instructions confusing #342

doolio opened this issue Dec 15, 2020 · 2 comments
Assignees

Comments

@doolio
Copy link
Contributor

doolio commented Dec 15, 2020

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
Copy link
Owner

romanz commented Aug 12, 2023

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
Copy link
Contributor Author

doolio commented Sep 11, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants