Skip to content

Update README #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jedie merged 1 commit into from
Dec 16, 2025
Merged

Update README #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,28 @@ Connect your Dragon 32 into your PC and LOAD/SAVE basic listings.
```bash
~$ git clone https://github.com/6809/DwLoadServer.git
~$ cd DwLoadServer
~/DwLoadServer$ ./devshell.py run serial
~/DwLoadServer$ ./cli.py run --help
```

The help page looks like:

[comment]: <> (✂✂✂ auto generated run help start ✂✂✂)
```
usage: ./cli.py run [-h] [RUN OPTIONS]

Start the DWLOAD server.

╭─ options ────────────────────────────────────────────────────────────────────────╮
│ -h, --help show this help message and exit │
│ --root-dir PATH Root path for dwload files (default: /home/jens/dwload-files) │
│ --interface STR Use interface: "becker" or "serial" (default: becker) │
│ --ip STR IP address for the interface (default: 127.0.0.1) │
│ --port INT Port number (default: 65504) │
│ --serial-port STR Serial port for serial interface (default: /dev/ttyUSB0) │
│ -v, --verbosity Verbosity level; e.g.: -v, -vv, -vvv, etc. (repeatable) │
╰──────────────────────────────────────────────────────────────────────────────────╯
```
[comment]: <> (✂✂✂ auto generated run help end ✂✂✂)


## features
Expand Down Expand Up @@ -221,6 +241,7 @@ usage: ./dev-cli.py [-h] {coverage,install,lint,mypy,nox,pip-audit,publish,test,
[comment]: <> (✂✂✂ auto generated history start ✂✂✂)

* [v0.6.0](https://github.com/6809/DwLoadServer/compare/v0.5.1...v0.6.0)
* 2025-12-16 - Update README
* 2025-12-16 - Migrate to UV
* 2023-09-24 - Update requirements
* [v0.5.1](https://github.com/6809/DwLoadServer/compare/v0.5.0...v0.5.1)
Expand Down
15 changes: 15 additions & 0 deletions dwload_server/tests/test_readme.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,21 @@ def test_main_help(self):
)
assert_cli_help_in_readme(text_block=stdout, marker='main help')

def test_run_help(self):
with NoColorEnvRich():
stdout = invoke(cli_bin=PACKAGE_ROOT / 'cli.py', args=['run', '--help'], strip_line_prefix='usage: ')
self.assert_in_content(
got=stdout,
parts=(
'usage: ./cli.py run [-h] [RUN OPTIONS]',
'interface',
'becker',
'serial',
'Start the DWLOAD server.',
),
)
assert_cli_help_in_readme(text_block=stdout, marker='run help')

def test_dev_help(self):
with NoColorEnvRich():
stdout = invoke(cli_bin=PACKAGE_ROOT / 'dev-cli.py', args=['--help'], strip_line_prefix='usage: ')
Expand Down
Loading