Skip to content

Commit c95fccd

Browse files
authored
Cleanup (#5)
1 parent 66d3826 commit c95fccd

8 files changed

Lines changed: 172 additions & 187 deletions

File tree

Pipfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ name = "pypi"
66
[packages]
77

88
[dev-packages]
9-
ansiscape = "==1.0.0a1"
9+
ansiscape = "*"
1010
black = "==21.9b0"
1111
flake8 = "*"
1212
isort = "*"

Pipfile.lock

Lines changed: 156 additions & 167 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Full documentation is published at [naughtty.readthedocs.io](https://naughtty.re
1414
pip install naughtty
1515
```
1616

17-
**NaughTTY** requires the host operating system to support forking and pseudo-terminals. GNU/Linux is good. At the time of writing, Windows is not. No guarantees are made for any operating system.
17+
**NaughTTY** requires the host operating system to support forking and pseudo-terminals. GNU/Linux is good. At the time of writing, Windows is not.
1818

1919
## Basic CLI usage
2020

docs/about.md

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

docs/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,15 @@ And that's where NaughTTY comes in!
3131
## The Solution: NaughTTY
3232

3333
NaughTTY is a CLI tool and Python package for running commands in a pseudo-terminal and capturing their output. This allows you to fool a command into emitting escape codes during redirection and piping when it normally wouldn't.
34+
35+
## Feedback
36+
37+
Please raise bugs, request features and ask questions at [github.com/cariad/naughtty/issues](https://github.com/cariad/naughtty/issues).
38+
39+
Mention if you're a [sponsor](https://github.com/sponsors/cariad) to ensure I respond as a priority. Thank you!
40+
41+
## Project
42+
43+
The source for `naughtty` is available at [github.com/cariad/naughtty](https://github.com/cariad/naughtty) under the MIT licence.
44+
45+
And, **hello!** I'm [Cariad Eccleston](https://cariad.io) and I'm an independent/freelance software engineer. If my work has value to you, please consider [sponsoring](https://github.com/sponsors/cariad/).

mkdocs.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ nav:
55
- install.md
66
- cli.md
77
- python.md
8-
- about.md
98
site_name: NaughTTY
109
theme:
1110
name: readthedocs

naughtty/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ def make_response(cli_args: Optional[List[str]] = None) -> str:
3131
# command's arguments:
3232
add_help=False,
3333
description="Executes a shell command in a pseudo-terminal and prints its output to stdout.",
34-
epilog="For example: naughtty pipenv --help > out.txt",
34+
epilog="Made with love by Cariad Eccleston: https://github.com/cariad/naughtty",
3535
)
3636

3737
parser.add_argument("command", help="command", nargs="*")

tests/test_cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ def test_make_response__for_execution__with_help() -> None:
5353
def test_make_response__for_help() -> None:
5454
response = make_response(["--help"])
5555
assert response.startswith("usage: ")
56-
assert response.endswith("naughtty pipenv --help > out.txt\n")
56+
assert response.endswith("Eccleston: https://github.com/cariad/naughtty\n")
5757
assert "naughtty" in response
5858

5959

0 commit comments

Comments
 (0)