Skip to content

Add python packages click and cryptography to build instructions#657

Merged
JF002 merged 1 commit intoInfiniTimeOrg:developfrom
NeroBurner:patch-1
Oct 22, 2021
Merged

Add python packages click and cryptography to build instructions#657
JF002 merged 1 commit intoInfiniTimeOrg:developfrom
NeroBurner:patch-1

Conversation

@NeroBurner
Copy link
Copy Markdown
Contributor

The script tools/mcuboot/imgtool/main.py imports the python packages
click and cryptography to create the target pinetime-mcuboot-app.
Add it tothe build instructions, as it was not installed on my system.

https://github.com/JF002/InfiniTime/blob/6f9f0e8b0e42a5526d47ca664534fb6b0ccb6ace/tools/mcuboot/imgtool/main.py#L19
https://github.com/JF002/InfiniTime/blob/6f9f0e8b0e42a5526d47ca664534fb6b0ccb6ace/tools/mcuboot/imgtool/keys/__init__.py#L19

Copy link
Copy Markdown
Collaborator

@Avamander Avamander left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be a reference to the actual dependency list of mcuboot's tools instead.

Generally documentation is not the way to handle dependencies.

@NeroBurner
Copy link
Copy Markdown
Contributor Author

@Avamander I added the reference, hope it is better this way

@Avamander
Copy link
Copy Markdown
Collaborator

Avamander commented Sep 10, 2021

Better.

But python -m venv .venv && source .venv/bin/activate && python -m pip install wheel && python -m pip install -r tools/mcuboot/requirements.txt would suffice and generally follows the best practices for development.

@NeroBurner
Copy link
Copy Markdown
Contributor Author

updated, please review

@geekbozu geekbozu added the documentation Improvements or additions to documentation label Oct 3, 2021
The script `tools/mcuboot/imgtool/main.py` imports the python packages
`click` and `cryptography` to create the target `pinetime-mcuboot-app`.
Add it tothe build instructions, as it was not installed on my system.

https://github.com/JF002/InfiniTime/blob/6f9f0e8b0e42a5526d47ca664534fb6b0ccb6ace/tools/mcuboot/imgtool/main.py#L19
https://github.com/JF002/InfiniTime/blob/6f9f0e8b0e42a5526d47ca664534fb6b0ccb6ace/tools/mcuboot/imgtool/keys/__init__.py#L19

Also add the commands to install the python requirements into a python
venv virtual environment.
@NeroBurner
Copy link
Copy Markdown
Contributor Author

rebased on current develop branch

@Avamander Avamander self-requested a review October 20, 2021 21:51
@JF002 JF002 merged commit 9363d44 into InfiniTimeOrg:develop Oct 22, 2021
@NeroBurner NeroBurner deleted the patch-1 branch October 25, 2021 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation hacktoberfest-accepted

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants