Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing documentation #47

Open
azariz opened this issue Nov 22, 2019 · 1 comment
Open

Missing documentation #47

azariz opened this issue Nov 22, 2019 · 1 comment

Comments

@azariz
Copy link

azariz commented Nov 22, 2019

No documentation found for the Python kit on the developers page as stated in the readme.

get a thorough introduction of how to use prismic.io kits, including this one.

And the package documentation is also incomplete, not all functions are described.

@lietu
Copy link

lietu commented Apr 28, 2020

Indeed, the links point to some generic site where the word Python is not mentioned even once.

And to make this worse nothing seems to actually work when you follow instructions - the prismic.io website says to use /api/v2 endpoint (doesn't list Python as an option at all), but apparently it should be /api.

The commands can throw really raw errors from HTTP responses but doesn't then even give any idea what the request it actually made was.

The functions themselves don't even have decent documentation that the help() builtin could show, but I end up having to guess what they might want as arguments.

When they do work the function return values are .. well .. less than optimal and quite surprising. For some reason p.query returns an OrderedDict, as if it mattered if page is 1st and results_per_page 2nd in that iterable. I would understand the use of OrderedDict for just the results, but this is OrderedDict in OrderedDict in OrderedDict in OrderedDict that makes the output on the Python shell really damn hard to read when trying to comprehend the structure.

Somehow those responses are also so broken that dict(p.query(...)) ends up raising

TypeError: attribute of type 'NoneType' is not callable

I gotta say this is one of the worst libraries I've seen out there, and I think I'll be much better off using the Rest API directly as this does nothing but give me headaches.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants