Skip to content

Commit 6f6add6

Browse files
committed
Remove examples, migrate to GitLab CI/CD templates
1 parent d6ebed5 commit 6f6add6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+27
-1346
lines changed

.github/workflows/check.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,13 @@ jobs:
2121
env:
2222
- lint
2323
- format
24-
- example-argparse
25-
- example-click
26-
- example-docopt
2724
- package
2825
- docs
2926
steps:
3027
- uses: actions/checkout@v4
3128
- uses: actions/setup-python@v5
3229
with:
33-
python-version: '3.10'
30+
python-version: '3.12'
3431
- name: Install prerequisites
3532
run: python -m pip install tox
3633
- name: Run ${{ matrix.env }}

.github/workflows/publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
- uses: actions/checkout@v4
1717
- uses: actions/setup-python@v5
1818
with:
19-
python-version: '3.10'
19+
python-version: '3.12'
2020
- name: Install prerequisites
2121
run: python -m pip install build twine wheel
2222
- name: Build package

README.rst

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@ cli-test-helpers |latest-version|
55

66
Useful 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

4951
See 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

5761
Development
5862
-----------
@@ -70,10 +74,3 @@ this:
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

copier.yaml

Lines changed: 0 additions & 14 deletions
This file was deleted.

examples/README.rst

Lines changed: 0 additions & 25 deletions
This file was deleted.

examples/argparse/.gitignore

Lines changed: 0 additions & 14 deletions
This file was deleted.

examples/argparse/.gitlab-ci.yml

Lines changed: 0 additions & 74 deletions
This file was deleted.

examples/argparse/LICENSE

Lines changed: 0 additions & 1 deletion
This file was deleted.

examples/argparse/README.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

examples/argparse/pyproject.toml

Lines changed: 0 additions & 66 deletions
This file was deleted.

0 commit comments

Comments
 (0)