vintasoftware / python-api-checklist Goto Github PK

View Code? Open in Web Editor NEW

335.0 9.0 35.0 76 KB

Useful checklist for building good Python library APIs, based on "How to make a good library API" PyCon 2017 talk.

Home Page: https://devchecklists.com/python-api-checklist/

python api-rest

python-api-checklist's Introduction

Python API Checklist

Adding a New Language:

To add a new language you will need to create another markdown file containing the new acronym language:
- E.g. checklist-pt.md.
No further approval will be necessary;
The new checklist language should be visible on Devckecklists after you saved the file on your repository.

Important Notes:

Markdown is the only way to write checklists on Devchecklists;
For tips about how to use markdown to write checklists, please take a look at these raw files:
- checklist-en.md sample markdown;
- README.md contained on this repository;
- Another checklists markdowns from Devchecklists.
Changes on the checklist repository will reflect on the current checklist of Devchecklists.

Commercial Support

This project, as other Vinta open-source projects, is used in products of Vinta clients. We are always looking for exciting work, so if you need any commercial support, feel free to get in touch: [email protected]

python-api-checklist's People

Contributors

Stargazers

Watchers

python-api-checklist's Issues

Clear all button

To clear checked inputs. Important to have a dialog confirmation before doing it.

Heroku down [as of 2019-02-09]

Hi,

Just noticed that the website is down: https://devchecklists.com/python-api-checklist/

It returns HTTP 503 with the following:

Application error

An error occurred in the application and your page could not be served. If you are the application owner, check your logs for details. You can do this from the Heroku CLI with the command
heroku logs --tail

ideas for useful additions

some ideas:

use keyword-only arguments for any function argument with a non-obvious meaning, e.g. a function that fetches "items" (whatever those may be) from a url, but can optionally take a timeout should use def fetch_items(url, *, timeout=...) to force the caller to be explicit. this makes code that calls this function much simpler to read. "explicit is better than implicit."
never use True/False return values to indicate success or failure. instead, raise an appropriate exception when things go wrong, and if the function succeeds, return either nothing (side effect only) or a meaningful value. this is especially important for security-sensitive apis, e.g. verify_signature(data, sig) should always raise an exception since a status code is easy to ignore, which may lead to serious bugs.