Documentation

[evijit]

Could you please put up a little documentation and usage examples for the functions mentioned in endpoints.py? I want to start from a website and recursively get the links of other domains connected to it, along with the number of redirects. A clear documentation would be welcome.

[benjaminestes]

Hey @AvijitGhosh82 —thanks for checking out Pyscape! A few places to start:

• Moz documentation for that API: http://moz.com/help/guides/moz-api/mozscape/api-reference/link-metrics
• The way the CLI calls batch_url_metrics()
• The comments in endpoints.py that define what the function expects to see

The Moz API is very frustrating and difficult to understand. I designed the library to return reasonable info based on what most people would want to see. You might just try to call the endpoint function and see what it returns. The "params" object passed to the endpoint is where you control what the API will return. If you don't specify an object, a default is created which will return something that usually meets expectations.

Unfortunately I haven't touched this library in a year or so now and it's not a priority to invest in documentation for it.