pyinfra 3.0.dev0__tar.gz → 3.0.1__tar.gz

pyinfra-3.0.1/CHANGELOG.md

@@ -0,0 +1,73 @@
+# v3.0.1
+
+- Switch to `command -v` not `which` in `server.Which` fact (@lemmi)
+- Fix detection of xbps in `server.packages` operation (@romain-dartigues)
+- Fix argument typo in operations doc (@scoufman)
+- Add expanded note about detected changes + hidden side effects during execution
+- Fix missing global arguments in group data files
+- Fix `--group-data` CLI argument behaviour
+- Remove unused/dead `--quiet` flag
+
+# v3.0
+
+Welcome to pyinfra v3! This version is the biggest overhaul of pyinfra since it was created back in 2015. Most v2 deployment code should be automatically compatible, but as always be aware. Major changes:
+
+### Runtime operation execution
+
+pyinfra now executes operations at runtime, rather than pre-generating commands. Although the change isn't noticeable this fixes an entire class of bugs and confusion. See the [limitations](https://docs.pyinfra.com/en/2.x/deploy-process.html#limitations) section in the v2 docs. All of those issues are now a thing of the past.
+
+This represents a huge overhaul of pyinfra's internals and should be a huge improvement for users.
+
+Care has been taken to reduce the overhead of this change which still supports the same diffs and change proposal mechanism.
+
+### CLI flow & prompts
+
+The pyinfra CLI will now prompt (instead of ignore, or immediately exit) when problems are encountered, allowing the user to choose to continue. Additionally an approval step is added before executing changes (this can be skipped with `-y` or setting the `PYINFRA_YES` environment variable).
+
+### Extendable connectors API, typing overhaul
+
+v3 of pyinfra includes for the first time a (mostly) typed internal API with proper support for IDE linting. There's a whole new connectors API that provides a framework for building new connectors.
+
+### Breaking changes
+
+- Rename `_use_sudo_password` argument to `_sudo_password`
+- Remove `winrm` connector and `windows*` operations/facts, moving to [`pyinfra-windows`](https://github.com/pyinfra-dev/pyinfra-windows)
+- The deploy decorator must now be called, ie used as `@deploy()`, and is now typed
+- Remove broken Ansible inventory connector
+
+### Operations & Facts
+
+- Add `docker.container`, `docker.image`, `docker.volume`, `docker.network` & `docker.prune` operations (@apecnascimento)
+- Add `runit.service` operation and `RunitStatus` fact (@lemmi)
+- Add `TmpDir` fact
+- Add `services` argument to systemd facts for filtering
+- Add type hints for all the operations (@stone-w4tch3r)
+- Lowercase pip packages properly (PEP-0426)
+- Rename `postgresql` -> `postgres` operations & facts (old ones still work)
+- Improve IP/MAC parsing in `NetworkDevices` fact (@sudoBash418)
+- Enable getting `Home` fact for other users (@matthijskooijman)
+- Use users correct home directory in `server.user_authorized_keys` operation (@matthijskooijman)
+- Fix `destination`/`not_destination` arguments in `iptables.rule` operation
+- Fix remote dirs when executing from Windows in `files.sync` operation (@Renerick)
+- Fix quoting of systemd unit names (@martenlienen)
+
+### Other Changes
+
+- Add new `_if` global argument to control operation execution at runtime
+- Add `--debug-all` flag to set debug logging for all packages
+- Retry SSH connections on failure (configurable, see [SSH connector](https://docs.pyinfra.com/en/3.x/connectors/ssh.html#available-data)) (@fwiesel)
+- Documentation typo fixes (@szepeviktor, @sudoBash418)
+- Fix handling of binary files in Docker connector (@matthijskooijman)
+- Add `will_change` attribute and `did_change` context manager to `OperationMeta`
+- Replace use of `pkg_resources` with `importlib.metadata` (@diazona)
+- Fix identifying Python inventory files as modules (@martenlienen)
+- Fix typed arguments order (@cdleonard)
+- Check that fact commands don't take global arguments (@martenlienen)
+
+# v2.x
+
+[See this file in the `2.x` branch](https://github.com/Fizzadar/pyinfra/blob/2.x/CHANGELOG.md).
+
+# v1.x
+
+[See this file in the `1.x` branch](https://github.com/Fizzadar/pyinfra/blob/1.x/CHANGELOG.md).

{pyinfra-3.0.dev0/pyinfra.egg-info → pyinfra-3.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyinfra
-Version: 3.0.dev0
+Version: 3.0.1
 Summary: pyinfra automates/provisions/manages/deploys infrastructure.
 Home-page: https://pyinfra.com
 Author: Nick / Fizzadar
@@ -16,19 +16,75 @@ Classifier: Intended Audience :: Information Technology
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: System :: Systems Administration
 Classifier: Topic :: System :: Installation/Setup
 Classifier: Topic :: Utilities
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: gevent>=1.5
+Requires-Dist: paramiko<4,>=2.7
+Requires-Dist: click>2
+Requires-Dist: jinja2<4,>2
+Requires-Dist: python-dateutil<3,>2
+Requires-Dist: setuptools
+Requires-Dist: configparser
+Requires-Dist: pywinrm
+Requires-Dist: typeguard
+Requires-Dist: distro<2,>=1.6
+Requires-Dist: packaging>=16.1
+Requires-Dist: graphlib_backport; python_version < "3.9"
+Requires-Dist: typing-extensions; python_version < "3.11"
+Requires-Dist: importlib_metadata>=3.6; python_version < "3.10"
 Provides-Extra: test
+Requires-Dist: pytest==8.2.1; extra == "test"
+Requires-Dist: coverage==7.5.1; extra == "test"
+Requires-Dist: pytest-cov==5.0.0; extra == "test"
+Requires-Dist: black==24.4.2; extra == "test"
+Requires-Dist: isort==5.13.2; extra == "test"
+Requires-Dist: flake8==7.0.0; extra == "test"
+Requires-Dist: flake8-black==0.3.6; extra == "test"
+Requires-Dist: flake8-isort==6.1.1; extra == "test"
+Requires-Dist: mypy; extra == "test"
+Requires-Dist: types-cryptography; extra == "test"
+Requires-Dist: types-paramiko; extra == "test"
+Requires-Dist: types-python-dateutil; extra == "test"
+Requires-Dist: types-PyYAML; extra == "test"
+Requires-Dist: types-setuptools; extra == "test"
 Provides-Extra: docs
+Requires-Dist: pyinfra-guzzle_sphinx_theme==0.16; extra == "docs"
+Requires-Dist: myst-parser==2.0.0; extra == "docs"
+Requires-Dist: sphinx==6.2.1; extra == "docs"
 Provides-Extra: dev
-Provides-Extra: ansible
-License-File: LICENSE.md
+Requires-Dist: pytest==8.2.1; extra == "dev"
+Requires-Dist: coverage==7.5.1; extra == "dev"
+Requires-Dist: pytest-cov==5.0.0; extra == "dev"
+Requires-Dist: black==24.4.2; extra == "dev"
+Requires-Dist: isort==5.13.2; extra == "dev"
+Requires-Dist: flake8==7.0.0; extra == "dev"
+Requires-Dist: flake8-black==0.3.6; extra == "dev"
+Requires-Dist: flake8-isort==6.1.1; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: types-cryptography; extra == "dev"
+Requires-Dist: types-paramiko; extra == "dev"
+Requires-Dist: types-python-dateutil; extra == "dev"
+Requires-Dist: types-PyYAML; extra == "dev"
+Requires-Dist: types-setuptools; extra == "dev"
+Requires-Dist: pyinfra-guzzle_sphinx_theme==0.16; extra == "dev"
+Requires-Dist: myst-parser==2.0.0; extra == "dev"
+Requires-Dist: sphinx==6.2.1; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: ipython; extra == "dev"
+Requires-Dist: ipdb; extra == "dev"
+Requires-Dist: ipdbplugin; extra == "dev"
+Requires-Dist: flake8-spellcheck==0.12.1; extra == "dev"
+Requires-Dist: redbaron; extra == "dev"
 
 <p align="center">
     <a href="https://pyinfra.com">
@@ -36,47 +92,42 @@ License-File: LICENSE.md
     </a>
 </p>
 
-<p align="center">
-    <em>pyinfra automates infrastructure super fast at massive scale<br />ad-hoc command execution, service deployment, configuration management and more</em>
+<p>
+    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. Think <code>ansible</code> but Python instead of YAML, and a lot faster.
 </p>
 
 ---
 
-<p align="center">
-    <a href="https://docs.pyinfra.com"><strong>Documentation</strong></a> &rArr;
+<h3>
     <a href="https://docs.pyinfra.com/page/getting-started.html"><strong>Getting Started</strong></a> &bull;
-    <a href="https://docs.pyinfra.com/page/examples.html"><strong>Examples</strong></a> &bull;
+    <a href="https://github.com/pyinfra-dev/pyinfra-examples"><strong>Examples Repo</strong></a> &bull;
+    <a href="https://matrix.to/#/#pyinfra:matrix.org"><strong>Chat on Matrix</strong></a>
+</h3>
+<p>
+    <a href="https://docs.pyinfra.com"><strong>Documentation</strong></a> &bull;
     <a href="https://docs.pyinfra.com/page/support.html"><strong>Help & Support</strong></a> &bull;
     <a href="https://docs.pyinfra.com/page/contributing.html"><strong>Contributing</strong></a>
 </p>
 
-<p align="center">
-    Chat (both bridged) &rArr;
-    <a href="https://matrix.to/#/#pyinfra:matrix.org"><strong><code>#pyinfra</code> on Matrix</strong></a> &bull;
-    <a href="https://discord.gg/w3XxuKw"><strong>Discord</strong></a>
-</p>
-
 ---
 
 Why pyinfra? Design features include:
 
 + 🚀 **Super fast** execution over thousands of hosts with predictable performance.
 + 🚨 **Instant debugging** with realtime stdin/stdout/stderr output (`-vvv`).
-+ 🔄 **Idempotent operations** that enable diffs and `--dry` runs before executing any changes.
-+ 📦 **Extendable** with _any_ Python package as configured & written in standard Python.
-+ 💻 **Agentless execution** against SSH/Docker/subprocess/WinRM hosts.
-+ 🔌 **Integrated** with Docker, Terraform, Vagrant/Mech & Ansible out of the box.
-
-When you run pyinfra you'll see something like ([non animated version](https://pyinfra.com/static/example_deploy.png)):
++ 🔄 **Idempotent operations** that enable diffs and dry runs before making changes.
++ 📦 **Extendable** with the entire Python package ecosystem.
++ 💻 **Agentless execution** against anything with shell access.
++ 🔌 **Integrated** with connectors for Docker, Terraform, Vagrant and more.
 
 <img width="100%" src="https://pyinfra.com/static/example_deploy.gif" />
 
 ## Quickstart
 
-Install pyinfra with [`pipx`](https://pipxproject.github.io/pipx/) (recommended) or `pip`:
+Install pyinfra with `pip`:
 
 ```
-pipx install pyinfra
+pip install pyinfra
 ```
 
 Now you can execute commands on hosts via SSH:
@@ -85,7 +136,7 @@ Now you can execute commands on hosts via SSH:
 pyinfra my-server.net exec -- echo "hello world"
 ```
 
-Or execute in Docker, on the local machine, and other [connectors](https://docs.pyinfra.com/page/connectors.html):
+Or target Docker containers, the local machine, and other [connectors](https://docs.pyinfra.com/page/connectors.html):
 
 ```sh
 pyinfra @docker/ubuntu exec -- echo "Hello world"

{pyinfra-3.0.dev0 → pyinfra-3.0.1}/README.md

@@ -4,47 +4,42 @@
     </a>
 </p>
 
-<p align="center">
-    <em>pyinfra automates infrastructure super fast at massive scale<br />ad-hoc command execution, service deployment, configuration management and more</em>
+<p>
+    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. Think <code>ansible</code> but Python instead of YAML, and a lot faster.
 </p>
 
 ---
 
-<p align="center">
-    <a href="https://docs.pyinfra.com"><strong>Documentation</strong></a> &rArr;
+<h3>
     <a href="https://docs.pyinfra.com/page/getting-started.html"><strong>Getting Started</strong></a> &bull;
-    <a href="https://docs.pyinfra.com/page/examples.html"><strong>Examples</strong></a> &bull;
+    <a href="https://github.com/pyinfra-dev/pyinfra-examples"><strong>Examples Repo</strong></a> &bull;
+    <a href="https://matrix.to/#/#pyinfra:matrix.org"><strong>Chat on Matrix</strong></a>
+</h3>
+<p>
+    <a href="https://docs.pyinfra.com"><strong>Documentation</strong></a> &bull;
     <a href="https://docs.pyinfra.com/page/support.html"><strong>Help & Support</strong></a> &bull;
     <a href="https://docs.pyinfra.com/page/contributing.html"><strong>Contributing</strong></a>
 </p>
 
-<p align="center">
-    Chat (both bridged) &rArr;
-    <a href="https://matrix.to/#/#pyinfra:matrix.org"><strong><code>#pyinfra</code> on Matrix</strong></a> &bull;
-    <a href="https://discord.gg/w3XxuKw"><strong>Discord</strong></a>
-</p>
-
 ---
 
 Why pyinfra? Design features include:
 
 + 🚀 **Super fast** execution over thousands of hosts with predictable performance.
 + 🚨 **Instant debugging** with realtime stdin/stdout/stderr output (`-vvv`).
-+ 🔄 **Idempotent operations** that enable diffs and `--dry` runs before executing any changes.
-+ 📦 **Extendable** with _any_ Python package as configured & written in standard Python.
-+ 💻 **Agentless execution** against SSH/Docker/subprocess/WinRM hosts.
-+ 🔌 **Integrated** with Docker, Terraform, Vagrant/Mech & Ansible out of the box.
-
-When you run pyinfra you'll see something like ([non animated version](https://pyinfra.com/static/example_deploy.png)):
++ 🔄 **Idempotent operations** that enable diffs and dry runs before making changes.
++ 📦 **Extendable** with the entire Python package ecosystem.
++ 💻 **Agentless execution** against anything with shell access.
++ 🔌 **Integrated** with connectors for Docker, Terraform, Vagrant and more.
 
 <img width="100%" src="https://pyinfra.com/static/example_deploy.gif" />
 
 ## Quickstart
 
-Install pyinfra with [`pipx`](https://pipxproject.github.io/pipx/) (recommended) or `pip`:
+Install pyinfra with `pip`:
 
 ```
-pipx install pyinfra
+pip install pyinfra
 ```
 
 Now you can execute commands on hosts via SSH:
@@ -53,7 +48,7 @@ Now you can execute commands on hosts via SSH:
 pyinfra my-server.net exec -- echo "hello world"
 ```
 
-Or execute in Docker, on the local machine, and other [connectors](https://docs.pyinfra.com/page/connectors.html):
+Or target Docker containers, the local machine, and other [connectors](https://docs.pyinfra.com/page/connectors.html):
 
 ```sh
 pyinfra @docker/ubuntu exec -- echo "Hello world"

{pyinfra-3.0.dev0 → pyinfra-3.0.1}/pyinfra/api/__init__.py

@@ -11,6 +11,9 @@ from .config import Config  # noqa: F401 # pragma: no cover
 from .deploy import deploy  # noqa: F401 # pragma: no cover
 from .exceptions import DeployError  # noqa: F401 # pragma: no cover
 from .exceptions import (  # noqa: F401
+    FactError,
+    FactTypeError,
+    FactValueError,
     InventoryError,
     OperationError,
     OperationTypeError,