Skip to content

Commit

Permalink
add notes on using from python.
Browse files Browse the repository at this point in the history
  • Loading branch information
ConorSheehan1 committed Apr 13, 2020
1 parent 83c7629 commit 6767e23
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,18 @@ osxdocker
![clear_log_example](.github/images/clear_log_example.png)

This cli uses https://github.com/google/python-fire
Check out the docs for more details on usage, setting up bash completion, etc.
Also worth noting this cli doesn't support --version due to a quirk with fire.
```bash
osxdocker version # works fine
osxdocker --version # won't work
```
Check out the docs for more details on usage, setting up bash completion, etc.
Also worth noting:
1. Because the package uses fire, it can be imported like a normal python package. e.g.
```python
from osxdocker.docker_logs import DockerLogs
DockerLogs().log_path('foo')
```
2. This cli doesn't support `--version` due to a quirk with fire.
```bash
osxdocker version # works fine
osxdocker --version # won't work
```

#### Edge cases and gotchas
Container names are unique, but containers are filtered by regex, so you can still run into issues.
Expand Down

0 comments on commit 6767e23

Please sign in to comment.