@@ -5,14 +5,15 @@ cli-test-helpers |latest-version|
55
66Useful helpers for writing tests for your Python CLI program.
77
8- Writing tests for a command line interface (CLI) tool ` may not seem strictly
9- straight-forward `_ when you think in terms of unit tests . Especially, when you
10- use the `argparse `_ module or the `click `_ package, control of the application
11- entry point is a bit taken away from you.
8+ Writing tests for a command line interface (CLI) application is ` more difficult
9+ than it seems at first sight `_ . Especially, when you use the ` argparse `_ module
10+ or the `docopt `_ or `click `_ package, control of the application entry point is
11+ a bit taken away from you.
1212
13- But it's not all that bad. This package is here to help. The `examples `_ give
14- you some guidance on how to get started, and the helpers allow you to deal with
15- common cases, such as mocking CLI arguments and environment variable values.
13+ But it's not all that bad. This package is here to help. The Painless Software
14+ `CLI Copier template `_ offers some guidance on how to get started, and the
15+ CLI test helpers allow you to deal with common cases, such as mocking CLI
16+ arguments and environment variable values.
1617
1718.. |latest-version | image :: https://img.shields.io/pypi/v/cli-test-helpers.svg
1819 :target: https://pypi.org/project/cli-test-helpers
@@ -35,11 +36,12 @@ common cases, such as mocking CLI arguments and environment variable values.
3536.. |docs-status | image :: https://img.shields.io/readthedocs/python-cli-test-helpers/latest.svg
3637 :target: https://readthedocs.org/projects/python-cli-test-helpers/
3738 :alt: Documentation Status
38- .. _ may not seem strictly straight-forward : https://stackoverflow.com/questions/13493288/
39+ .. _ more difficult than it seems at first sight : https://stackoverflow.com/questions/13493288/
3940.. _argparse : https://docs.python.org/3/library/argparse.html
4041.. _click : https://click.palletsprojects.com/
42+ .. _docopt : http://docopt.org/
4143.. _documentation : https://python-cli-test-helpers.readthedocs.io/
42- .. _ examples : https://github .com/painless-software/python-cli-test-helpers/tree/main/examples
44+ .. _ CLI Copier template : https://gitlab .com/painless-software/cicd/app/cli
4345
4446.. links-marker
4547
@@ -48,11 +50,13 @@ Documentation
4850
4951See the `documentation `_ for installation instructions and a tutorial.
5052
51- Examples
52- --------
53+ Examples / Quickstart
54+ ---------------------
5355
54- The `examples `_ folder contains hands-on example projects you can start to use
55- directly.
56+ Visit the Painless Software `CLI Copier template `_ to inspect hands-on CLI
57+ application blueprints for the most popular CLI frameworks. The Copier tool
58+ lets you create your own CLI application project with tests and modern CI/CD,
59+ effortlessly.
5660
5761Development
5862-----------
7074 tox -e lint,py312 # run a few environments
7175 tox -e py # run tests with local default Python
7276 tox # run entire suite
73-
74- The included example projects can be tested independently with their dedicated
75- environments, e.g.
76-
77- .. code-block :: shell
78-
79- tox -e example-docopt
0 commit comments