Docs: Add basic localhost example to "Using the API" page - Githubissues

pyinfra-dev / pyinfra

pyinfra turns Python code into shell commands and runs them on your servers. Execute ad-hoc commands and write declarative operations. Target SSH servers, local machine and Docker containers. Fast and scales from one server to thousands.

https://pyinfra.com

MIT License

3.92k stars 382 forks source link

Docs: Add basic localhost example to "Using the API" page #1212

Closed pirate closed 2 months ago

pirate commented 2 months ago

Fixes: https://github.com/pyinfra-dev/pyinfra/issues/1211

This aims to improve the "getting started with the API" experience a bit:

add link to API source code
moves .old/api_deploy.py link to a Full Example section
add Basic Localhost Example section
- clearly shows what imports are necessary
- demonstrates setting up an inventory using @local for localhost
- demonstrates setting up a Config with SUDO=True
- includes links to API References docs on Inventory, Config, and facts
- demonstrates how to run ops and collect facts afterwards