search

alexshpilkin / dvrip

Python DVRIP (Xiongmai, XMEye, Sofia protocol) library and tools
Creative Commons Zero v1.0 Universal
65 stars 30 forks source link

How do you install and use this? #11

Open PeteC1773 opened 1 year ago

PeteC1773 commented 1 year ago

Looks good from peeking into the code - but how to use? I don't seem to even be able to install it (on Ubuntu 20 - I don't have much idea with python personally).

Appreciate there have been a couple of issues raised about the readme but in the absence of a readme maybe someone else can just leave a comment saying basically how to install and run it?

jogando commented 1 year ago

I'm at the same place as you are..this may help https://github.com/alexshpilkin/dvrip/issues/4

alexshpilkin commented 1 year ago

@PeteC1773 I’m glad to see you’re interested, but I have to warn you: the code is kind of in a rough state right now (as can be seen from the utter lack of documentation), and a lot of things which one would want (and which are present in the various manufacturer-supplied apps) are missing (primarily because I haven’t figured out a way to put a schema and a reasonable API around the so-called “configuration tree” and not die of boredom in the process—the thing is massive). I’ve also lost access to my test device about a year ago for reasons outside my control, so my ability to work on this further is impaired in the short term. Still, if you can get this thing to do what you want, I’ll be happy :) Just be aware that achieving that will have to be on you, unfortunately.

Regarding installation: you install this the same way you install any Python package on your system of choice. On Windows, install Python, make sure the scripts directory of that installation is on your PATH, run pip install dvrip[find,log,time] (add --user to taste), then start exploring the dvr command. On Linux, the steps are basically the same, but you’ll probably want to install the dependencies (typing_inspect, dateparser, humanize) using your system’s package manager instead (I’m not sure what you’ll have to do with the outdated typing_inspect dependency... try using a newer one, override the version check and pray it works, probably). On macOS, I honestly have no idea (something something Homebrew?).

I understand these instructions are somewhat brief, and I hate to discourage anyone from exploring by making things appear more complex than they are. However, if your goal is to solve a problem in an efficient manner rather than have fun with computers, and you don’t understand what I’ve written above, then this tool is probably not in a state to be useful to you just yet, and as I said, I’m not reasonably able to fix that in the next few months at the very least.

Still, if you’re curious and not short on time, I’m willing to answer more specific questions if you want me to. I’m not sure I’m the best intro Python resource you could use, but the decision is yours :)