Merged #62 #65 #69 and added tests using gh-actions

.github/workflows/formatter.yml

@@ -0,0 +1,36 @@
+name: Format code
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install dependencies
+        run: |
+          python -m pip install -U pip
+          pip install black isort autoflake
+
+      - name: Format code with black
+        run: |
+          black src tests
+
+      - name: Sort imports with isort
+        run: |
+          isort src tests
+
+      - name: Remove unused imports with autoflake
+        run: |
+          autoflake --in-place --remove-all-unused-imports --remove-unused-variables --recursive .
+
+      - name: Commit changes
+        uses: EndBug/add-and-commit@v4
+        with:
+          author_name: ${{ github.actor }}
+          author_email: ${{ github.actor }}@users.noreply.github.com
+          message: "Format code with black"
+          add: "src"
+          branch: ${{ github.ref }}

.github/workflows/tests.yml

@@ -0,0 +1,27 @@
+name: Tests
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ['3.7', '3.8', '3.9', '3.10']
+        click-version: ['7.1.2', '8.1.2']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox tox-gh-actions click==${{ matrix.click-version }}
+    - name: Test with tox
+      run: tox

.gitignore

@@ -4,6 +4,9 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+#mypy cache
+.mypy_cache
+
 # C extensions
 *.so
 

MANIFEST.in

@@ -1,2 +1 @@
-global-exclude *.py[cdo] __pycache__ *.so *.pyd
 include LICENSE

Makefile

@@ -3,5 +3,5 @@ release:
 .PHONY: release
 
 testrepl:
-	@python bin/testrepl.py repl
+	@python tests/testrepl.py repl
 .PHONY: testrepl

README.md

@@ -0,0 +1,90 @@
+click-repl
+===
+
+[![build](https://travis-ci.org/click-contrib/click-repl.svg?branch=master)](https://travis-ci.org/click-contrib/click-repl)
+[![Tests](https://github.com/GhostOps77/click-repl/actions/workflows/tests.yml/badge.svg?branch=GhostOps77-patch-1)](https://github.com/GhostOps77/click-repl/actions/runs/4074019555/jobs/7018648133)
+[![License](https://img.shields.io/pypi/l/click-repl?label=License)](https://github.com/GhostOps77/click-repl/blob/GhostOps77-patch-1/LICENSE)
+![Python - version](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)
+[![PyPi - version](https://img.shields.io/badge/pypi-v0.2.0-blue)](https://pypi.org/project/click-repl/)
+![wheels](https://img.shields.io/piwheels/v/click-repl?label=wheel)
+![PyPI - Status](https://img.shields.io/pypi/status/click)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/click-repl)
+
+Installation
+===
+
+Installation is done via pip:
+```
+pip install click-repl
+```
+Usage
+===
+
+In your [click](http://click.pocoo.org/) app:
+
+```py
+import click
+from click_repl import register_repl
+
+@click.group()
+def cli():
+    pass
+
+@cli.command()
+def hello():
+    click.echo("Hello world!")
+
+register_repl(cli)
+cli()
+```
+In the shell:
+```
+$ my_app repl
+> hello
+Hello world!
+> ^C
+$ echo hello | my_app repl
+Hello world!
+```
+**Features not shown:**
+
+- Tab-completion.
+- The parent context is reused, which means `ctx.obj` persists between
+  subcommands. If you're keeping caches on that object (like I do), using the
+  app's repl instead of the shell is a huge performance win.
+- `!` - prefix executes shell commands.
+
+You can use the internal `:help` command to explain usage.
+
+
+Advanced Usage
+===
+
+For more flexibility over how your REPL works you can use the `repl` function
+directly instead of `register_repl`. For example, in your app:
+
+```py
+import click
+from click_repl import repl
+from prompt_toolkit.history import FileHistory
+
+@click.group()
+def cli():
+    pass
+
+@cli.command()
+def myrepl():
+    prompt_kwargs = {
+        'history': FileHistory('/etc/myrepl/myrepl-history'),
+    }
+    repl(click.get_current_context(), prompt_kwargs=prompt_kwargs)
+
+cli()
+```
+And then your custom `myrepl` command will be available on your CLI, which
+will start a REPL which has its history stored in
+`/etc/myrepl/myrepl-history` and persist between sessions.
+
+Any arguments that can be passed to the [`python-prompt-toolkit`](https://github.com/prompt-toolkit/python-prompt-toolkit) [Prompt](http://python-prompt-toolkit.readthedocs.io/en/stable/pages/reference.html?prompt_toolkit.shortcuts.Prompt#prompt_toolkit.shortcuts.Prompt) class
+can be passed in the `prompt_kwargs` argument and will be used when
+instantiating your `Prompt`.