search

twrecked / pyaarlo

Asynchronous Arlo Component for Python
GNU Lesser General Public License v3.0
50 stars 30 forks source link

Work in progress - Add manual page #140

Closed cpina closed 4 months ago

cpina commented 6 months ago

I am packaging pyaarlo for Debian, so it will be available using apt on Debian and Ubuntu.

For doing this I need to write a manual page for any executable (like pyaarlo). I've started one in this MR. It's not finished but it would be great if an improved version of this could be part of this repository instead of being part of the Debian package only (it's usually better maintained by upstream repository than the Debian maintainer).

I've done it in groff straight ahead (the original manual language).

I am struggling a bit with the "pyaarlo dump". I don't have any Aarlo camera so I cannot test it - if a description could be provided it would be great. Otherwise, tomorrow, when I continue, I'll work something out.

As said: this is a draft and not finished but I thought that might be useful and perhaps @twrecked can improve before I have time.

twrecked commented 6 months ago

Thanks for this! I'll take a look.

As for the "dump" command, it's prints out everything that was returned from Arlo about the devices in the system. Looking at the code the only parameter that works is "all" so I guess I started it but never got round to finishing it.

cpina commented 6 months ago

If you want to add the manual that I started: since I did only a draft we can remove the copyright notice at the end. It's a standard copyright for pages maintained by Debian developers but if it's in upstream no need of this and makes sense if it just uses the same license as everything, same copyright. Since it was only a draft to start it I'm fine removing it :-)

Sadly, I don't have any Aarlo devices. The main drive of packaging this for me is that I'm packaging simplemonitor :-) which uses pyaarlo. But I'm liking pyaarlo, next time that I get a camera I might make sure to be compatible to use pyaarlo :-)

twrecked commented 4 months ago

Sorry for the delay here. I was on holiday over Christmas and I'm just getting back to things. I'll merge this now and take a look after.