Skip to content

Commit

Permalink
πŸ”₯ Remove placeholder CLI (#12)
Browse files Browse the repository at this point in the history
* πŸ”₯ Remove placeholder CLI

* πŸ“š [reference] Remove API reference
  • Loading branch information
cjolowicz committed Dec 8, 2021
1 parent 5706101 commit 0e615a8
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 16 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,12 @@ Install the package with development requirements:
$ poetry install
You can now run an interactive Python session,
or the command-line interface:
or the command-line tools:

.. code:: console
$ poetry run python
$ poetry run cjolowicz-scripts
$ poetry run <script>
.. _Poetry: https://python-poetry.org/
.. _Nox: https://nox.thea.codes/
Expand Down
1 change: 0 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
mbox2maildir
stardate
python-stdlib
reference
contributing
Code of Conduct <codeofconduct>
License <license>
Expand Down
9 changes: 0 additions & 9 deletions docs/reference.rst

This file was deleted.

1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ furo = ">=2021.11.12"
sphinx-argparse = ">=0.3.1"

[tool.poetry.scripts]
cjolowicz-scripts = "cjolowicz_scripts.__main__:main"
stardate = "cjolowicz_scripts.stardate:main"
dependabot-rebase-all = "cjolowicz_scripts.dependabot_rebase_all:main"
mbox2maildir = "cjolowicz_scripts.mbox2maildir:main"
Expand Down
11 changes: 8 additions & 3 deletions tests/test_main.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
"""Test cases for the __main__ module."""
import pytest
from click import BaseCommand
from click.testing import CliRunner

from cjolowicz_scripts import __main__
from cjolowicz_scripts import dependabot_rebase_all


@pytest.fixture
Expand All @@ -11,7 +12,11 @@ def runner() -> CliRunner:
return CliRunner()


def test_main_succeeds(runner: CliRunner) -> None:
@pytest.mark.parametrize(
"main",
[dependabot_rebase_all.main],
)
def test_help(runner: CliRunner, main: BaseCommand) -> None:
"""It exits with a status code of zero."""
result = runner.invoke(__main__.main)
result = runner.invoke(main, ["--help"])
assert result.exit_code == 0

0 comments on commit 0e615a8

Please sign in to comment.