changes in features.rst

gilesknap · gilesknap · commit 383160148775 · 2022-08-18T09:55:57.000Z
diff --git a/.github/workflows/code.yml b/.github/workflows/code.yml
@@ -9,6 +9,8 @@ on:
 
 jobs:
   lint:
+    # pull requests are a duplicate of a branch push if they are from within the
+    # same repo. Skip these
     if: github.event_name != 'pull_request' || github.event.pull_request.repository == github.repository
     runs-on: "ubuntu-latest"
     steps:
diff --git a/README.rst b/README.rst
@@ -3,6 +3,12 @@ python3-pip-skeleton
 
 |code_ci| |docs_ci| |coverage| |pypi_version| |license|
 
+.. note::
+    
+    This project contains template code only. For documentation on how to
+    adopt this skeleton project see 
+    https://epics-containers.github.io/python3-pip-skeleton-cli
+
 This is where you should write a short paragraph that describes what your module does,
 how it does it, and why people should use it.
 
@@ -15,18 +21,9 @@ Releases       https://github.com/epics-containers/python3-pip-skeleton/releases
 
 This is where you should put some images or code snippets that illustrate
 some relevant examples. If it is a library then you might put some
-introductory code here:
-
-.. code:: python
-
-    from python3_pip_skeleton.hello import HelloClass
-
-    hello = HelloClass("me")
-    print(hello.format_greeting())
-
-Or if it is a commandline tool then you might put some example commands here::
+introductory code here.
 
-    python3-pip-skeleton person --times=2
+Or if it is a commandline tool then you might put some example commands here.
 
 .. |code_ci| image:: https://github.com/epics-containers/python3-pip-skeleton/workflows/Code%20CI/badge.svg?branch=main
     :target: https://github.com/epics-containers/python3-pip-skeleton/actions?query=workflow%3A%22Code+CI%22
diff --git a/docs/how-to.rst b/docs/how-to.rst
@@ -8,4 +8,4 @@ Practical step-by-step guides for the more experienced user.
 .. toctree::
     :caption: How-to Guides
 
-    how-to/accomplish-a-task
+    how-to/contributing
diff --git a/docs/how-to/accomplish-a-task.rst b/docs/how-to/accomplish-a-task.rst
diff --git a/docs/how-to/contributing.rst b/docs/how-to/contributing.rst
diff --git a/docs/reference.rst b/docs/reference.rst
@@ -9,7 +9,6 @@ Practical step-by-step guides for the more experienced user.
     :caption: Reference
 
     reference/api
-    reference/contributing
     Releases <https://github.com/epics-containers/python3-pip-skeleton/releases>
     Index <genindex.html#http://>
 
diff --git a/docs/reference/api.rst b/docs/reference/api.rst
@@ -9,16 +9,10 @@ API
 This is the internal API reference for python3_pip_skeleton
 
 You can mix verbose text with docstring and signature extraction by
-using ``autoclass`` and ``autofunction`` directives instead of
-``automodule`` below.
+using ``autoclass`` and ``autofunction`` directives. Or use
+``automodule`` to generate the text entirely from a .py file.
 
 .. data:: python3_pip_skeleton.__version__
     :type: str
 
     Version number as calculated by https://github.com/pypa/setuptools_scm
-
-.. automodule:: python3_pip_skeleton.hello
-    :members:
-
-    ``python3_pip_skeleton.hello``
-    -----------------------------------------
diff --git a/docs/tutorials/installation.rst b/docs/tutorials/installation.rst
@@ -8,7 +8,7 @@ Installation
     inside DLS, they are intended for external use.
 
     If you want to contribute to the library itself, please follow
-    the `../reference/contributing` instructions.
+    the `../how-to/contributing` instructions.
 
 
 Check your version of python
diff --git a/src/python3_pip_skeleton/__main__.py b/src/python3_pip_skeleton/__main__.py
@@ -1,18 +1,14 @@
 from argparse import ArgumentParser
 
 from . import __version__
-from .hello import HelloClass, say_hello_lots
 
 __all__ = ["main"]
 
 
 def main(args=None):
     parser = ArgumentParser()
     parser.add_argument("--version", action="version", version=__version__)
-    parser.add_argument("name", help="Name of the person to greet")
-    parser.add_argument("--times", type=int, default=5, help="Number of times to greet")
     args = parser.parse_args(args)
-    say_hello_lots(HelloClass(args.name), args.times)
 
 
 # test with: pipenv run python -m python3_pip_skeleton
diff --git a/src/python3_pip_skeleton/hello.py b/src/python3_pip_skeleton/hello.py
diff --git a/tests/test_dls_python3_skeleton.py b/tests/test_dls_python3_skeleton.py
@@ -1,26 +1,7 @@
 import subprocess
 import sys
 
-from python3_pip_skeleton import __main__, __version__, hello
-
-
-def test_hello_class_formats_greeting() -> None:
-    inst = hello.HelloClass("person")
-    assert inst.format_greeting() == "Hello person"
-
-
-def test_hello_lots_defaults(capsys) -> None:
-    hello.say_hello_lots()
-    captured = capsys.readouterr()
-    assert captured.out == "Hello me\n" * 5
-    assert captured.err == ""
-
-
-def test_cli_greets(capsys) -> None:
-    __main__.main(["person", "--times=2"])
-    captured = capsys.readouterr()
-    assert captured.out == "Hello person\n" * 2
-    assert captured.err == ""
+from python3_pip_skeleton import __main__, __version__
 
 
 def test_cli_version():
