You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/bug-report-no-hw.yml
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ body:
14
14
id: version
15
15
attributes:
16
16
label: Esptool Version
17
-
description: The output of `git describe` if working with the sources, output of `esptool.py version` otherwise. If possible, consider [updating esptool](https://docs.espressif.com/projects/esptool/en/latest/installation.html#how-to-update).
17
+
description: The output of `git describe` if working with the sources, output of `esptool version` otherwise. If possible, consider [updating esptool](https://docs.espressif.com/projects/esptool/en/latest/installation.html#how-to-update).
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/issue-with-hw.yml
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ body:
21
21
id: version
22
22
attributes:
23
23
label: Esptool Version
24
-
description: The output of `git describe` if working with the sources, output of `esptool.py version` otherwise. If possible, consider [updating esptool](https://docs.espressif.com/projects/esptool/en/latest/installation.html#how-to-update).
24
+
description: The output of `git describe` if working with the sources, output of `esptool version` otherwise. If possible, consider [updating esptool](https://docs.espressif.com/projects/esptool/en/latest/installation.html#how-to-update).
This will install ``esptool.py``’s dependencies and create some executable script wrappers in the user’s ``bin`` directory. The wrappers will run the scripts found in the git working directory directly, so any time the working directory contents change it will pick up the new versions.
24
+
This will install ``esptool``'s dependencies and create some executable script wrappers in the user's ``bin`` directory. The wrappers will run the scripts found in the git working directory directly, so any time the working directory contents change it will pick up the new versions.
25
25
26
-
It’s also possible to run the scripts directly from the working directory with this Development Mode installation.
26
+
It's also possible to run the scripts directly from the working directory with this Development Mode installation.
27
27
28
-
To also install additional tools needed for actually developing and testing ``esptool.py``, run this command to install a development copy of ``esptool.py`` *plus* packages useful for development:
28
+
To also install additional tools needed for actually developing and testing ``esptool``, run this command to install a development copy of ``esptool`` *plus* packages useful for development:
29
29
30
30
::
31
31
@@ -36,7 +36,7 @@ To also install additional tools needed for actually developing and testing ``es
36
36
Reporting Issues
37
37
----------------
38
38
39
-
Please report bugs in ``esptool.py`` if you find them. However, before reporting a bug please check through the following:
39
+
Please report bugs in ``esptool`` if you find them. However, before reporting a bug please check through the following:
40
40
41
41
* `Troubleshooting Guide <https://docs.espressif.com/projects/esptool/en/latest/troubleshooting.html>`_ - common problems and known issues.
42
42
@@ -58,7 +58,7 @@ Before Contributing
58
58
59
59
Before sending us a Pull Request, please consider this list of points:
60
60
61
-
* Have you tried running ``esptool.py`` test suite locally?
61
+
* Have you tried running ``esptool`` test suite locally?
62
62
63
63
* Is the code adequately commented for people to understand how it is structured?
64
64
@@ -73,7 +73,7 @@ Before sending us a Pull Request, please consider this list of points:
73
73
Code Style & Static Analysis
74
74
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
75
75
76
-
Please follow these coding standards when writing code for ``esptool.py``:
76
+
Please follow these coding standards when writing code for ``esptool``:
77
77
78
78
Pre-Commit Checks
79
79
"""""""""""""""""
@@ -92,13 +92,13 @@ On the first commit ``pre-commit`` will install the hooks, subsequent checks wil
92
92
Conventional Commits
93
93
""""""""""""""""""""
94
94
95
-
``esptool.py`` complies with the `Conventional Commits standard <https://www.conventionalcommits.org/en/v1.0.0/#specification>`_. Every commit message is checked with `Conventional Precommit Linter <https://github.com/espressif/conventional-precommit-linter>`_, ensuring it adheres to the standard.
95
+
``esptool`` complies with the `Conventional Commits standard <https://www.conventionalcommits.org/en/v1.0.0/#specification>`_. Every commit message is checked with `Conventional Precommit Linter <https://github.com/espressif/conventional-precommit-linter>`_, ensuring it adheres to the standard.
96
96
97
97
98
98
Ruff
99
99
""""
100
100
101
-
``esptool.py`` is `PEP8 <https://peps.python.org/pep-0008/>`_ compliant and enforces this style guide. For compliance checking, we use `ruff <https://docs.astral.sh/ruff/>`_.
101
+
``esptool`` is `PEP8 <https://peps.python.org/pep-0008/>`_ compliant and enforces this style guide. For compliance checking, we use `ruff <https://docs.astral.sh/ruff/>`_.
102
102
``Ruff`` also auto-format files in the same style as previously used ``black``.
103
103
104
104
@@ -122,22 +122,22 @@ In the event of false positives, you can adjust the configuration in the `.codes
122
122
Automated Integration Tests
123
123
^^^^^^^^^^^^^^^^^^^^^^^^^^^
124
124
125
-
The test directory contains a `pytest <https://docs.pytest.org/>`_ integration suite with some integration tests for ``esptool.py``, ``espefuse.py``, and ``espsecure.py``.
125
+
The test directory contains a `pytest <https://docs.pytest.org/>`_ integration suite with some integration tests for ``esptool``, ``espefuse``, and ``espsecure``.
126
126
127
-
It is necessary to have ``esptool.py`` installed (see `Development Setup`_) in your environment in order to run these tests.
127
+
It is necessary to have ``esptool`` installed (see `Development Setup`_) in your environment in order to run these tests.
128
128
129
129
The following tests run automatically by GitHub Actions for each Pull Request. You can run them locally to check for regressions in the respective functionality:
130
130
131
131
* ``test_imagegen.py`` tests the ``elf2image`` command
132
132
* ``test_image_info.py`` tests the ``image-info`` command
133
133
* ``test_mergebin.py`` tests the ``merge-bin`` command
134
-
* ``test_modules.py`` tests the modules used by ``esptool.py`` for regressions
* ``test_espsecure_hsm.py`` tests support of external HSM signing in ``espsecure.py``. These tests require additional prerequisites, see ``SoftHSM2 setup`` in the `tests workflow definition <https://github.com/espressif/esptool/blob/master/.github/workflows/test_esptool.yml>`_ for more information.
134
+
* ``test_modules.py`` tests the modules used by ``esptool`` for regressions
* ``test_espsecure_hsm.py`` tests support of external HSM signing in ``espsecure``. These tests require additional prerequisites, see ``SoftHSM2 setup`` in the `tests workflow definition <https://github.com/espressif/esptool/blob/master/.github/workflows/test_esptool.yml>`_ for more information.
137
137
138
138
The following tests are not run automatically by GitHub Actions, because they need real connected hardware. Therefore, they need to be run locally in a command line:
139
139
140
-
* ``test_esptool.py`` contains integration tests for ``esptool.py`` and needs to be run against real Espressif hardware with the following format:
140
+
* ``test_esptool.py`` contains integration tests for ``esptool`` and needs to be run against real Espressif hardware with the following format:
@@ -153,15 +153,15 @@ The following tests are not run automatically by GitHub Actions, because they ne
153
153
154
154
Some tests might fail at higher baud rates on some hardware.
155
155
156
-
* ``test_esptool_sdm.py`` contains integration tests for ``esptool.py`` with chips in secure download mode. It needs to be run against real Espressif hardware (with active SDM). The command line format is the same as for ``test_esptool.py``.
156
+
* ``test_esptool_sdm.py`` contains integration tests for ``esptool`` with chips in secure download mode. It needs to be run against real Espressif hardware (with active SDM). The command line format is the same as for ``test_esptool.py``.
157
157
158
158
The following tests are not run automatically by GitHub Actions, but can be run locally in a command line:
159
159
160
-
* ``test_espefuse.py`` tests ``espefuse.py`` functionality. To run it:
160
+
* ``test_espefuse.py`` tests ``espefuse`` functionality. To run it:
161
161
162
162
``pytest test_espefuse.py --chip <name of chip>``
163
163
164
-
These test use the ``--virt`` virtual mode of ``espefuse.py`` to safely test the functionality without a connection to a chip and without the possibility of affecting the actual eFuses in a real hardware.
164
+
These test use the ``--virt`` virtual mode of ``espefuse`` to safely test the functionality without a connection to a chip and without the possibility of affecting the actual eFuses in a real hardware.
Visit the [documentation](https://docs.espressif.com/projects/esptool/) or run `esptool.py -h`.
9
+
Visit the [documentation](https://docs.espressif.com/projects/esptool/) or run `esptool -h`.
10
10
11
11
## Contribute
12
12
13
-
If you're interested in contributing to esptool.py, please check the [contributions guide](https://docs.espressif.com/projects/esptool/en/latest/contributing.html).
13
+
If you're interested in contributing to esptool, please check the [contributions guide](https://docs.espressif.com/projects/esptool/en/latest/contributing.html).
14
14
15
15
## About
16
16
17
-
esptool.py was initially created by Fredrik Ahlberg (@[themadinventor](https://github.com/themadinventor/)), and later maintained by Angus Gratton (@[projectgus](https://github.com/projectgus/)). It is now supported by Espressif Systems. It has also received improvements from many members of the community.
17
+
esptool was initially created by Fredrik Ahlberg (@[themadinventor](https://github.com/themadinventor/)), and later maintained by Angus Gratton (@[projectgus](https://github.com/projectgus/)). It is now supported by Espressif Systems. It has also received improvements from many members of the community.
0 commit comments