Release v2.0 🎉

Author: Fizzadar

CHANGELOG.md

@@ -1,4 +1,4 @@
-# v2.0rc1
+# v2.0
 
 The first `2.x` release! Like v0 -> v1 this release mostly removes legacy APIs and methods which show warnings in v1. Major changes:
 
@@ -23,20 +23,22 @@ This change also brings **support for all of the execution global arguments to f
 **Other breaking changes** (warnings shown in v1 for most):
 
 + Non-existent host data raises an `AttributeError` when accessed via `host.data.X`
++ Change default `branch` argument to `None` in `git.repo` operation
 + `present` argument removed from `mysql.privileges` operation
 + Config variables must now be set on the global `config` object
 + Old style `host.fact.fact_name` access has been removed
 + The legacy `init.*` operations have been removed
-+ `--facts` and `--operations` CLI flags/modes removed
++ Stop lowercasing package names in facts & operations
++ Remove `--facts` and `--operations` CLI flags
 + Remove `--debug-data` CLI flag
 + Remove `Windows` prefix on all Windows facts
 + Rename `name` argument to `path` in `windows_files.*` operations
 + Remove support for jinja2 template parsing in string arguments
 + Remove old `pyinfra.modules` module/import
 + Remove `config.MIN_PYINFRA_VERSION`
 + Remove `branch` and `create_branch` arguments in `git.worktree` operation
++ Remove `touch_periodic` argument in `apt.update` operation (never used)
 + `pyinfra.api.connectors` module moved to `pyinfra.connectors`
-+ Stop lowercasing package names in facts & operations
 
 **Deprecated** (showing warnings, to be removed in v3):
 

README.md

@@ -44,50 +44,59 @@ When you run pyinfra you'll see something like ([non animated version](https://p
 
 ## Quickstart
 
-pyinfra can be installed via pip:
+Install pyinfra with [`pipx`](https://pipxproject.github.io/pipx/) (recommended) or `pip`:
 
-```sh
-pip install pyinfra
+```
+pipx install pyinfra
 ```
 
-Now you can execute commands & operations over SSH:
+Now you can execute commands on hosts via SSH:
 
 ```sh
-# Execute an arbitrary shell command
 pyinfra my-server.net exec -- echo "hello world"
+```
+
+Or execute in Docker, on the local machine, and other [connectors]():
+
+```sh
+pyinfra @docker/ubuntu exec -- echo "Hello world"
+pyinfra @local exec -- echo "Hello world"
+```
 
+As well as executing commands you can define state using [operations]():
+
+```sh
 # Install iftop apt package if not present
-pyinfra my-server.net apt.packages iftop sudo=true update=true
+pyinfra @docker/ubuntu apt.packages iftop update=true _sudo=true
 ```
 
-These can then be saved to a _deploy file_, let's call it `deploy.py`:
+Which can then be saved as a Python file like `deploy.py`:
+
 
 ```py
 from pyinfra.operations import apt
 
 apt.packages(
-    name='Ensure iftop is installed',
+    name="Ensure iftop is installed",
     packages=['iftop'],
-    sudo=True,
     update=True,
+    _sudo=True,
 )
 ```
 
-And executed with:
+The hosts can also be saved in a file, for example `inventory.py`:
 
-```sh
-pyinfra my-server.net deploy.py
+```py
+targets = ["@docker/ubuntu", "my-test-server.net"]
 ```
 
-or
+
+And executed together:
 
 ```sh
-pyinfra @docker/ubuntu deploy.py
+pyinfra inventory.py deploy.py
 ```
 
-## [Documentation](https://docs.pyinfra.com)
+Now you know the building blocks of pyinfra! By combining inventory, operations and Python code you can deploy anything.
 
-+ [Getting started](https://docs.pyinfra.com/page/getting_started.html)
-+ [Writing deploys](https://docs.pyinfra.com/page/deploys.html)
-+ [Using the CLI](https://docs.pyinfra.com/page/cli.html)
-+ [Connectors](https://docs.pyinfra.com/page/connectors.html)
+See the more detailed [getting started](https://docs.pyinfra.com/page/getting-started.html) or [using operations](https://docs.pyinfra.com/page/using-operations.html) guides. See how to use [inventory & data](https://docs.pyinfra.com/page/inventory-data.html), [global arguments](https://docs.pyinfra.com/page/arguments.html) and [the CLI](https://docs.pyinfra.com/page/cli.html) or check out the [documented examples](https://docs.pyinfra.com/page/examples.html).