vintasoftware / python-api-checklist

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

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: [e-mail]

Copyright (c) 2018 Vinta Serviços e Soluções Tecnológicas Ltda. MIT License