https://github.com/vintasoftware/python-api-checklist

Useful checklist for building good Python library APIs, based on "How to make a good library API" PyCon 2017 talk.
https://github.com/vintasoftware/python-api-checklist

api-rest python

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/vintasoftware/python-api-checklist
• Owner: vintasoftware
• Created: 2017-05-18T22:39:44.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-12-08T19:50:49.000Z (over 6 years ago)
• Last Synced: 2025-03-31T13:18:24.351Z (about 1 month ago)
• Topics: api-rest, python
• Homepage: https://devchecklists.com/python-api-checklist/
• Size: 74.2 KB
• Stars: 333
• Watchers: 8
• Forks: 34
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• starred-awesome - python-api-checklist - Useful checklist for building good Python library APIs, based on "How to make a good library API" PyCon 2017 talk: https://www.youtube.com/watch?v=4mkFfce46zE (HTML)

README

        
[![alt text](https://s3-sa-east-1.amazonaws.com/www.vinta.com.br/images/dont_delete/devchecklist-logo.png "Devchecklists Logo")](https://devchecklists.com)

# 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:](https://www.loc.gov/standards/iso639-2/php/code_list.php)

    * 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`](https://raw.githubusercontent.com/vintasoftware/devchecklists-template/master/checklist-en.md) sample markdown;

    * [ ] [`README.md`](https://raw.githubusercontent.com/vintasoftware/devchecklists-template/master/README.md) contained on this repository;

    * [ ] Another checklists markdowns from [Devchecklists](https://devchecklists.com).

  * [ ] Changes on the checklist repository will reflect on the current checklist of Devchecklists.

## Commercial Support

[![alt text](https://avatars2.githubusercontent.com/u/5529080?s=200&v=4 "Vinta Logo")](https://vintasoftware.com)

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]

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

[MIT License](LICENSE.txt)