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: source/guides/creating-command-line-tools.rst
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ Creating and packaging command-line tools
5
5
=========================================
6
6
7
7
This guide will walk you through creating and packaging a standalone command-line application
8
-
that can be installed with :ref:`pipx`, a tool creating and managing :term:`Python Virtual Environments <Virtual Environment>`
8
+
that can be installed with :ref:`pipx`, a tool for creating and managing :term:`Python Virtual Environments <Virtual Environment>`
9
9
and exposing the executable scripts of packages (and available manual pages) for use on the command-line.
10
10
11
11
Creating the package
@@ -98,7 +98,7 @@ Now, add an empty :file:`__init__.py` file, to define the project as a regular :
98
98
99
99
The file :file:`__main__.py` marks the main entry point for the application when running it via :mod:`runpy`
100
100
(i.e. ``python -m greetings``, which works immediately with flat layout, but requires installation of the package with src layout),
101
-
so initizalize the command-line interface here:
101
+
so initialize the command-line interface here:
102
102
103
103
.. code-block:: python
104
104
@@ -162,7 +162,7 @@ To just run the program without installing it permanently, use ``pipx run``, whi
162
162
163
163
$ pipx run --spec . greet --knight
164
164
165
-
This syntax is a bit unpractical, however; as the name of the entry point we defined above does not match the package name,
165
+
This syntax is a bit impractical, however; as the name of the entry point we defined above does not match the package name,
166
166
we need to state explicitly which executable script to run (even though there is only on in existence).
167
167
168
168
There is, however, a more practical solution to this problem, in the form of an entry point specific to ``pipx run``.
@@ -184,7 +184,7 @@ default one and run it, which makes this command possible:
184
184
Conclusion
185
185
==========
186
186
187
-
You know by now how to package a command-line application written in Python. A further step could be to distribute you package,
187
+
You know by now how to package a command-line application written in Python. A further step could be to distribute your package,
188
188
meaning uploading it to a :term:`package index <Package Index>`, most commonly :term:`PyPI <Python Package Index (PyPI)>`. To do that, follow the instructions at :ref:`Packaging your project`. And once you're done, don't forget to :ref:`do some research <analyzing-pypi-package-downloads>` on how your package is received!
0 commit comments