make a pypi package

This commit is contained in:
Florent de Lamotte 2025-03-25 10:22:14 +01:00
parent 855eb4a437
commit 92a4cead67
2 changed files with 9 additions and 7 deletions

View file

@ -1,21 +1,22 @@
# mccli
# meshcore-cli
mccli.py : CLI interface to MeschCore companion app over BLE, TCP or Serial
meshcore-cli : CLI interface to MeschCore companion app over BLE, TCP or Serial
## Install
You should install [meshcore](https://github.com/fdlamotte/meshcore_py) package first via pip.
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 :
<pre>
$ pip install meshcore
$ pipx install meshcore-cli
</pre>
Then you can put `mccli.py` program in your path.
It will install you `meshcore-cli` and `meshcli`, which is an alias to the former.
## Usage
<pre>
$ mccli.py &lt;args&gt; &lt;commands&gt;
$ meshcli &lt;args&gt; &lt;commands&gt;
</pre>
### Arguments

3
mccli.py → src/meshcore_cli/meshcore_cli.py Executable file → Normal file
View file

@ -278,4 +278,5 @@ async def main(argv):
while len(cmds) > 0 :
cmds = await next_cmd(mc, cmds)
asyncio.run(main(sys.argv[1:]))
def cli():
asyncio.run(main(sys.argv[1:]))