Skip to content

Commit 92a4cea

Browse files
committed
make a pypi package
1 parent 855eb4a commit 92a4cea

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
1-
# mccli
1+
# meshcore-cli
22

3-
mccli.py : CLI interface to MeschCore companion app over BLE, TCP or Serial
3+
meshcore-cli : CLI interface to MeschCore companion app over BLE, TCP or Serial
44

55
## Install
66

7-
You should install [meshcore](https://github.com/fdlamotte/meshcore_py) package first via pip.
7+
Meshcore-cli depends on the (python meshcore)[https://github.com/fdlamotte/meshcore_py] package. You can install both via `pip` or `pipx` using the command :
88

99
<pre>
10-
$ pip install meshcore
10+
$ pipx install meshcore-cli
1111
</pre>
1212

13-
Then you can put `mccli.py` program in your path.
13+
It will install you `meshcore-cli` and `meshcli`, which is an alias to the former.
14+
1415

1516
## Usage
1617

1718
<pre>
18-
$ mccli.py &lt;args&gt; &lt;commands&gt;
19+
$ meshcli &lt;args&gt; &lt;commands&gt;
1920
</pre>
2021

2122
### Arguments

mccli.py renamed to src/meshcore_cli/meshcore_cli.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,4 +278,5 @@ async def main(argv):
278278
while len(cmds) > 0 :
279279
cmds = await next_cmd(mc, cmds)
280280

281-
asyncio.run(main(sys.argv[1:]))
281+
def cli():
282+
asyncio.run(main(sys.argv[1:]))

0 commit comments

Comments
 (0)