There's an API for That!

You might have seen bots like GitHub bots, Discord bots, Slack bots. How do these bots work? There's an API for that! You can use third-party APIs to build web apps and automations, including bots. Come learn the best practices on how to work with APIs using Python.

Transcript

1. THERE’S AN API FOR THAT! Mariatta Python Core Developer https://mariatta.ca fosstodon.org/@mariatta
2. What even is a bot? Mariatta fosstodon.org/@mariatta
3. GitHub Bot Mariatta fosstodon.org/@mariatta
4. Gitter Bot Mariatta fosstodon.org/@mariatta
5. Bot == ? Mariatta fosstodon.org/@mariatta
6. Bot == Web app Mariatta fosstodon.org/@mariatta
7. Bot == Web app == Automation Mariatta fosstodon.org/@mariatta
8. Your Web App Mariatta fosstodon.org/@mariatta Third Party The internet
9. Your Web App Mariatta fosstodon.org/@mariatta Third Party The internet API
10. Your Web App Mariatta fosstodon.org/@mariatta Third Party API
11. Webhooks Third Party Mariatta fosstodon.org/@mariatta Your Web App (incoming API calls)
12. Webhooks Third Party Mariatta fosstodon.org/@mariatta Your Web App API
13. Working with APIs Mariatta fosstodon.org/@mariatta
14. Also called Developer Docs Start with Tutorials if you are new API endpoints are listed under Resources Read the Documentation Mariatta fosstodon.org/@mariatta
15. Also called Developer Docs Start with Tutorials if you are new API endpoints are listed under Resources Read the Documentation Mariatta fosstodon.org/@mariatta
16. # Don’t do this TOKEN = “my token” # Do this TOKEN = os.environ[”TOKEN”] API keys or OAuth2 Keep your credentials secret!! Don’t store as plain text Don’t commit to your codebase Use environment variables Authentication Mariatta fosstodon.org/@mariatta
17. Helper library for working with third-party APIs Also called toolkit or SDKs or wrappers Abstraction and simplification Hides details of request authorization, headers, signature verification Write code in your favorite language (e.g. Python) No client library? Write your own Use Swagger Client if they have OpenAPI Use Client Libraries Mariatta fosstodon.org/@mariatta
18. Use your favorite web framework Django REST framework, Flask, FastAPI, aiohttp, etc Always verify incoming requests Use webhook secret Pass a specific request header The client library should handle this. If not, file a feature request! Webhooks Mariatta fosstodon.org/@mariatta
19. GitHub APIs Mariatta fosstodon.org/@mariatta
20. Dev Docs: https://docs.github.com/en/developers Authenticate using Personal Access Token, or OAuth2 Official client libraries: in Ruby, .NET, JavaScript Third Party Python library: https://gidgethub.readthedocs.io My GitHub App tutorial: https://github-app-tutorial.readthedocs.io >>> python3 -m pip install gidgethub GitHub APIs Mariatta fosstodon.org/@mariatta
21. API for opening an issue response = await gh.post( f'/repos/{owner}/{repo}/issues', data={ 'title': 'Found a bug!', 'body': 'Use more emoji!', } ) GitHub APIs with gidgethub Mariatta fosstodon.org/@mariatta
22. Webhook event handler @router.register("issue", action="opened") async def issue_opened(event, gh, *args, **kwargs): ... response = await gh.post( f"{issue_url}/comments", data={"body": msg}, oauth_token=installation_access_token["token"], ) GitHub APIs with gidgethub Mariatta fosstodon.org/@mariatta
23. Vacation Aquarium-Cam /Potato-Cam Mariatta fosstodon.org/@mariatta
24. Mariatta fosstodon.org/@mariatta Flickr API Upload photos of aquarium/ potato garden using Flickr API https://github.com/Mariatta/raspberry_pi_webcam_py Source Code https://www.flickr.com/photos/134275259@N03/ Flickr Album
25. Mariatta fosstodon.org/@mariatta mariatta.ca Thank you