@@ -66,7 +66,7 @@ Packaging is configured by:
6666
6767- [ ` pyproject.toml ` ] ( ./pyproject.toml )
6868
69- To package the project as both a
69+ To package the project as both a
7070[ source distribution] ( https://packaging.python.org/en/latest/flow/#the-source-distribution-sdist )
7171and a [ wheel] ( https://packaging.python.org/en/latest/specifications/binary-distribution-format/ ) :
7272
@@ -98,8 +98,8 @@ uv publish
9898
9999Automated code quality checks are performed using [ Nox] ( https://nox.thea.codes/en/stable/ ) and
100100[ ` nox-uv ` ] ( https://github.com/dantebben/nox-uv ) . Nox will automatically create virtual environments
101- and run commands based on [ ` noxfile.py ` ] ( ./noxfile.py ) for unit testing, PEP 8 style guide checking, type
102- checking and documentation generation.
101+ and run commands based on [ ` noxfile.py ` ] ( ./noxfile.py ) for unit testing, PEP 8 style guide
102+ checking, type checking and documentation generation.
103103
104104> [ !NOTE]
105105> ` nox ` is installed into the virtual environment automatically by the ` uv sync ` command
@@ -254,11 +254,11 @@ run:
254254
255255``` shell
256256uv run nox -s docs_serve
257- ```
257+ ```
258258
259259and open < http://127.0.0.1:8000 > in a browser.
260260
261- Each time the ` main ` Git branch is updated, the
261+ Each time the ` main ` Git branch is updated, the
262262[ ` .github/workflows/pages.yml ` ] ( .github/workflows/pages.yml ) GitHub Action will
263263automatically build the user guide and publish it to [ GitHub Pages] ( https://pages.github.com/ ) .
264264This is configured in the ` docs_github_pages ` Nox session. This hosted user guide
@@ -313,7 +313,7 @@ distribution has been packaged and installed, thereby catching any errors in pac
313313installation scripts, which are common. Having the Python packages in the project root subverts
314314this isolation for two reasons:
315315
316- 1 . Calling ` python ` in the project root (for example, ` python -m pytest tests/ ` )
316+ 1 . Calling ` python ` in the project root (for example, ` python -m pytest tests/ ` )
317317 [ causes Python to add the current working directory] ( https://docs.pytest.org/en/latest/pythonpath.html#invoking-pytest-versus-python-m-pytest )
318318 (the project root) to ` sys.path ` , which Python uses to find modules. Because the source
319319 package ` fact ` is in the project root, it shadows the ` fact ` package installed in the Nox
@@ -332,7 +332,7 @@ prevent this, there are three possible solutions:
332332 to ` tests ` .
3333333 . Move the source packages to a dedicated ` src ` folder.
334334
335- The dedicated ` src ` directory is the
335+ The dedicated ` src ` directory is the
336336[ recommended solution] ( https://docs.pytest.org/en/latest/pythonpath.html#test-modules-conftest-py-files-inside-packages )
337337by ` pytest ` when using Nox and the solution this blueprint promotes because it is the least brittle
338338even though it deviates from the traditional Python project structure. It results is a directory
@@ -368,10 +368,10 @@ using [pip-licenses](https://github.com/raimon49/pip-licenses):
368368``` shell
369369$ uv run nox -s licenses
370370...
371- Name Version License
372- Pygments 2.19.1 BSD License
373- click 8.1.8 BSD License
374- markdown-it-py 3.0.0 MIT License
371+ Name Version License
372+ Pygments 2.19.1 BSD License
373+ click 8.1.8 BSD License
374+ markdown-it-py 3.0.0 MIT License
375375```
376376
377377# Container
@@ -423,6 +423,7 @@ to allow easy execution on macOS and Linux.
423423# ///
424424
425425import httpx
426+
426427print (httpx.get(" https://example.com" ).text)
427428```
428429
@@ -460,32 +461,32 @@ project:
460461
461462- Settings | Search "Hard wrap at" (Note, this will be automatically set by
462463 [ ` .editorconfig ` ] ( ./.editorconfig ) )
463- - Editor | Code Style | General | Hard wrap at: 99
464+ - Editor | Code Style | General | Hard wrap at: 99
464465
465466- Settings | Search "Optimize Imports"
466- - Editor | Code Style | Python | Imports
467- - ☑ Sort import statements
468- - ☑ Sort imported names in "from" imports
469- - ☐ Sort plain and "from" imports separately within a group
470- - ☐ Sort case-insensitively
471- - Structure of "from" imports
472- - ◎ Leave as is
473- - ◉ Join imports with the same source
474- - ◎ Always split imports
467+ - Editor | Code Style | Python | Imports
468+ - ☑ Sort import statements
469+ - ☑ Sort imported names in "from" imports
470+ - ☐ Sort plain and "from" imports separately within a group
471+ - ☐ Sort case-insensitively
472+ - Structure of "from" imports
473+ - ◎ Leave as is
474+ - ◉ Join imports with the same source
475+ - ◎ Always split imports
475476
476477- Settings | Search "Docstrings"
477- - Tools | Python Integrated Tools | Docstrings | Docstring Format: Google
478+ - Tools | Python Integrated Tools | Docstrings | Docstring Format: Google
478479
479480- Settings | Search "pytest"
480- - Tools | Python Integrated Tools | Testing | Default test runner: pytest
481+ - Tools | Python Integrated Tools | Testing | Default test runner: pytest
481482
482483- Settings | Search "Force parentheses"
483- - Editor | Code Style | Python | Wrapping and Braces | "From" Import Statements
484- - ☑ Force parentheses if multiline
484+ - Editor | Code Style | Python | Wrapping and Braces | "From" Import Statements
485+ - ☑ Force parentheses if multiline
485486
486487## Ruff Integration
487488
488- Integrate [ Ruff] ( https://docs.astral.sh/ruff/editors/setup/#pycharm ) linting and
489+ Integrate [ Ruff] ( https://docs.astral.sh/ruff/editors/setup/#pycharm ) linting and
489490formatting into PyCharm.
490491
491492### Linting and Formatting
@@ -500,15 +501,15 @@ Now, on <kbd>ctrl+s</kbd>, the current source file will be automatically formatt
500501sorted on save.
501502
502503> [ !TIP]
503- > These tools work best if you properly mark directories as excluded from the project that should
504- > be, such as ` .nox ` . See
505- > < https://www.jetbrains.com/help/pycharm/project-tool-window.html#content_pane_context_menu > on
504+ > These tools work best if you properly mark directories as excluded from the project that should
505+ > be, such as ` .nox ` . See
506+ > < https://www.jetbrains.com/help/pycharm/project-tool-window.html#content_pane_context_menu > on
506507> how to Right-Click | Mark Directory as | Excluded.
507508
508509## Nox Support
509510
510511[ PyCharm does not yet natively support Nox] ( https://youtrack.jetbrains.com/issue/PY-37302 ) . The
511- recommended way to launch Nox from PyCharm is to create a ** Python**
512+ recommended way to launch Nox from PyCharm is to create a ** Python**
512513[ Run Configuration] ( https://www.jetbrains.com/help/pycharm/run-debug-configuration.html ) .
513514
514515- Beside ** Script Path** , press ` ▼ ` and select ** Module name** : ` nox `
0 commit comments