@@ -48,7 +48,7 @@ We also rely on [npm](https://www.npmjs.com/) for installing a few dependencies
48
48
[ prettier] ( https://prettier.io/ ) for formatting non-Python files.
49
49
50
50
We have a [ Makefile] ( ../Makefile ) with commands that make it quick and easy for developers to get
51
- everything setup and perform common development tasks.
51
+ everything set up and perform common development tasks.
52
52
53
53
Nearly all project configuration, including for dependencies and quality tools is in the
54
54
[ pyproject.toml] ( ../pyproject.toml ) file.
@@ -234,16 +234,16 @@ _[this](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git
234
234
235
235
### Setting up for cmd2 development
236
236
237
- For doing ` cmd2 ` development, it is strongly recommended you create a virtual environment ` uv ` using
238
- the instructions in the next section.
237
+ For doing ` cmd2 ` development, it is strongly recommended you create a virtual environment using ` uv `
238
+ by following the instructions in the next section.
239
239
240
240
#### Create a new environment for cmd2 using uv
241
241
242
242
` cmd2 ` has support for using [ uv] ( https://github.com/astral-sh/uv ) for development.
243
243
244
244
` uv ` is single tool to replace ` pip ` , ` pip-tools ` , ` pipx ` , ` poetry ` , ` pyenv ` , ` twine ` , ` virtualenv ` ,
245
245
and more. ` cmd2 ` contains configuration for using ` uv ` in it's ` pyproject.toml ` file which makes it
246
- extremely easy to setup a ` cmd2 ` development environment using ` uv ` .
246
+ extremely easy to set up a ` cmd2 ` development environment using ` uv ` .
247
247
248
248
To create a virtual environment using the latest stable version of Python and install everything
249
249
needed for ` cmd2 ` development using ` uv ` , do the following from the root of your cloned ` cmd2 `
@@ -275,11 +275,11 @@ Linux or macOS:
275
275
source .venv/bin/activate
276
276
```
277
277
278
- Assuming you cloned the repository to ` ~/src/cmd2 ` and setup a virtual environment using ` uv ` ,
279
- ` cmd2 ` in this venv in
280
- [ editable mode] ( https://pip.pypa.io/en/stable/reference /pip_install/#editable-installs ) . Changes to
281
- the source code are immediately available when the python interpreter imports ` cmd2 ` , there is no
282
- need to re-install the module after every change. This command will also install all of the runtime
278
+ Assuming you cloned the repository to ` ~/src/cmd2 ` and set up a virtual environment using ` uv ` ,
279
+ ` cmd2 ` in this venv is in
280
+ [ editable mode] ( https://pip.pypa.io/en/stable/cli /pip_install/#editable-installs ) . Changes to the
281
+ source code are immediately available when the python interpreter imports ` cmd2 ` , there is no need
282
+ to re-install the module after every change. This command will also install all of the runtime
283
283
dependencies for ` cmd2 ` and modules used for development of ` cmd2 ` :
284
284
285
285
``` sh
@@ -320,7 +320,7 @@ $ make check
320
320
321
321
This will run all auto-formatters, linters, and type checkers to ensure code quality. You should run
322
322
this every time before committing any code. If this all runs successfully, then your virtual
323
- environment is setup and working properly.
323
+ environment is set up and working properly.
324
324
325
325
You can also run the example app and see a prompt that says "(Cmd)" running the command:
326
326
0 commit comments