From d4c3f5f00bc41831de78530442358068d4fb07c4 Mon Sep 17 00:00:00 2001 From: Tobias Raabe Date: Mon, 22 Apr 2024 18:09:38 +0000 Subject: [PATCH 1/4] [automated] Update plugin list --- docs/source/plugin_list.rst | 63 ++----------------------------------- 1 file changed, 2 insertions(+), 61 deletions(-) diff --git a/docs/source/plugin_list.rst b/docs/source/plugin_list.rst index a377efb67..040008d43 100644 --- a/docs/source/plugin_list.rst +++ b/docs/source/plugin_list.rst @@ -11,70 +11,11 @@ automatically. Packages classified as inactive are excluded. creating a PDF, because otherwise the table gets far too wide for the page. -This list contains 7 plugins. +This list contains 0 plugins. .. only:: not latex - ========================== ==================================================================== ============== ========= ============== - name summary last release status requires - ========================== ==================================================================== ============== ========= ============== - :pypi:`pytask-environment` Detect changes in your pytask environment and abort a project build. Feb 10, 2023 4 - Beta pytask (>=0.2) - :pypi:`pytask-julia` A Pytask plugin for Julia Oct 07, 2023 4 - Beta pytask >=0.4.0 - :pypi:`pytask-latex` Compile LaTeX documents with pytask. Nov 30, 2023 4 - Beta pytask >=0.4.0 - :pypi:`pytask-parallel` Parallelize the execution of tasks with pytask. Jan 12, 2024 4 - Beta pytask >=0.4.5 - :pypi:`pytask-r` Run R scripts with pytask. Oct 07, 2023 4 - Beta pytask >=0.4.0 - :pypi:`pytask-stata` Execute do-files with Stata and pytask. Jan 23, 2023 4 - Beta pytask (>=0.3) - :pypi:`pytask-vscode` Additional Logging for VS Code integration Nov 21, 2023 3 - Alpha pytask >=0.4.2 - ========================== ==================================================================== ============== ========= ============== -.. only:: latex - - - :pypi:`pytask-environment` - *last release*: Feb 10, 2023, - *status*: 4 - Beta, - *requires*: pytask (>=0.2) - - Detect changes in your pytask environment and abort a project build. - - :pypi:`pytask-julia` - *last release*: Oct 07, 2023, - *status*: 4 - Beta, - *requires*: pytask >=0.4.0 - - A Pytask plugin for Julia - - :pypi:`pytask-latex` - *last release*: Nov 30, 2023, - *status*: 4 - Beta, - *requires*: pytask >=0.4.0 - - Compile LaTeX documents with pytask. - :pypi:`pytask-parallel` - *last release*: Jan 12, 2024, - *status*: 4 - Beta, - *requires*: pytask >=0.4.5 - - Parallelize the execution of tasks with pytask. - - :pypi:`pytask-r` - *last release*: Oct 07, 2023, - *status*: 4 - Beta, - *requires*: pytask >=0.4.0 - - Run R scripts with pytask. - - :pypi:`pytask-stata` - *last release*: Jan 23, 2023, - *status*: 4 - Beta, - *requires*: pytask (>=0.3) - - Execute do-files with Stata and pytask. - - :pypi:`pytask-vscode` - *last release*: Nov 21, 2023, - *status*: 3 - Alpha, - *requires*: pytask >=0.4.2 +.. only:: latex - Additional Logging for VS Code integration From c3bb8c7a3c852a50d6711b0b40bb727b1799ea8f Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 22 Apr 2024 18:10:06 +0000 Subject: [PATCH 2/4] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/plugin_list.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/source/plugin_list.rst b/docs/source/plugin_list.rst index 040008d43..f535d74a3 100644 --- a/docs/source/plugin_list.rst +++ b/docs/source/plugin_list.rst @@ -18,4 +18,3 @@ This list contains 0 plugins. .. only:: latex - From 3f905be1e1092d0d97049159e11bc8f1cb63dfc7 Mon Sep 17 00:00:00 2001 From: Tobias Raabe Date: Tue, 23 Apr 2024 16:13:14 +0200 Subject: [PATCH 3/4] Fix. --- docs/source/plugin_list.rst | 78 +++++++++++++++++++++++++++++++++-- pyproject.toml | 5 +++ scripts/update_plugin_list.py | 14 +++++-- 3 files changed, 90 insertions(+), 7 deletions(-) diff --git a/docs/source/plugin_list.rst b/docs/source/plugin_list.rst index f535d74a3..19c1c9cc7 100644 --- a/docs/source/plugin_list.rst +++ b/docs/source/plugin_list.rst @@ -7,14 +7,86 @@ Plugin List PyPI projects that match "pytask-\*" are considered plugins and are listed automatically. Packages classified as inactive are excluded. -.. The following conditional uses a different format for this list when - creating a PDF, because otherwise the table gets far too wide for the - page. +.. warning:: + + Please be aware that this list is not a curated collection of projects and does not + undergo a systematic review process. It serves purely as an informational resource to + aid in the discovery of ``pytask`` plugins. + + Do not presume any endorsement from the ``pytask`` project or its developers, and + always conduct your own quality assessment before incorporating any of these plugins + into your own projects. This list contains 0 plugins. .. only:: not latex +<<<<<<< Updated upstream .. only:: latex +======= + ========================== ==================================================================== ============== ========= ============== + name summary last release status requires + ========================== ==================================================================== ============== ========= ============== + :pypi:`pytask-environment` Detect changes in your pytask environment and abort a project build. Feb 10, 2023 4 - Beta pytask (>=0.2) + :pypi:`pytask-julia` A Pytask plugin for Julia Oct 07, 2023 4 - Beta pytask >=0.4.0 + :pypi:`pytask-latex` Compile LaTeX documents with pytask. Nov 30, 2023 4 - Beta pytask >=0.4.0 + :pypi:`pytask-parallel` Parallelize the execution of tasks with pytask. Jan 12, 2024 4 - Beta pytask >=0.4.5 + :pypi:`pytask-r` Run R scripts with pytask. Apr 20, 2024 4 - Beta pytask>=0.4.5 + :pypi:`pytask-stata` Execute do-files with Stata and pytask. Jan 23, 2023 4 - Beta pytask (>=0.3) + :pypi:`pytask-vscode` Additional Logging for VS Code integration Nov 21, 2023 3 - Alpha pytask >=0.4.2 + ========================== ==================================================================== ============== ========= ============== + +.. only:: latex + + + :pypi:`pytask-environment` + *last release*: Feb 10, 2023, + *status*: 4 - Beta, + *requires*: pytask (>=0.2) + + Detect changes in your pytask environment and abort a project build. + + :pypi:`pytask-julia` + *last release*: Oct 07, 2023, + *status*: 4 - Beta, + *requires*: pytask >=0.4.0 + + A Pytask plugin for Julia + + :pypi:`pytask-latex` + *last release*: Nov 30, 2023, + *status*: 4 - Beta, + *requires*: pytask >=0.4.0 + + Compile LaTeX documents with pytask. + + :pypi:`pytask-parallel` + *last release*: Jan 12, 2024, + *status*: 4 - Beta, + *requires*: pytask >=0.4.5 + + Parallelize the execution of tasks with pytask. + + :pypi:`pytask-r` + *last release*: Apr 20, 2024, + *status*: 4 - Beta, + *requires*: pytask>=0.4.5 + + Run R scripts with pytask. + + :pypi:`pytask-stata` + *last release*: Jan 23, 2023, + *status*: 4 - Beta, + *requires*: pytask (>=0.3) + + Execute do-files with Stata and pytask. + + :pypi:`pytask-vscode` + *last release*: Nov 21, 2023, + *status*: 3 - Alpha, + *requires*: pytask >=0.4.2 + + Additional Logging for VS Code integration +>>>>>>> Stashed changes diff --git a/pyproject.toml b/pyproject.toml index ef9fa985e..b2a0cb046 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -72,6 +72,11 @@ test = [ "aiohttp", "coiled", ] +plugin-list = [ + "httpx>=0.27.0", + "tabulate[widechars]>=0.9.0", + "tqdm>=4.66.2", +] [project.urls] Changelog = "https://pytask-dev.readthedocs.io/en/stable/changes.html" diff --git a/scripts/update_plugin_list.py b/scripts/update_plugin_list.py index 56050e258..d7ca22076 100644 --- a/scripts/update_plugin_list.py +++ b/scripts/update_plugin_list.py @@ -52,9 +52,15 @@ PyPI projects that match "pytask-\*" are considered plugins and are listed automatically. Packages classified as inactive are excluded. -.. The following conditional uses a different format for this list when - creating a PDF, because otherwise the table gets far too wide for the - page. +.. warning:: + + Please be aware that this list is not a curated collection of projects and does not + undergo a systematic review process. It serves purely as an informational resource to + aid in the discovery of ``pytask`` plugins. + + Do not presume any endorsement from the ``pytask`` project or its developers, and + always conduct your own quality assessment before incorporating any of these plugins + into your own projects. """ @@ -87,7 +93,7 @@ def _escape_rst(text: str) -> str: def _iter_plugins() -> Generator[dict[str, str], None, None]: # noqa: C901 """Iterate over all plugins and format entries.""" regex = r">([\d\w-]*)" - response = httpx.get("https://pypi.org/simple", timeout=20) + response = httpx.get("https://pypi.org/simple/", timeout=20) matches = [ match From f1452d54e5f53c2d00674845a3745c30a4fd17c4 Mon Sep 17 00:00:00 2001 From: Tobias Raabe Date: Tue, 23 Apr 2024 16:21:23 +0200 Subject: [PATCH 4/4] Fix. --- docs/source/plugin_list.rst | 62 +---------------------------------- scripts/update_plugin_list.py | 22 +------------ 2 files changed, 2 insertions(+), 82 deletions(-) diff --git a/docs/source/plugin_list.rst b/docs/source/plugin_list.rst index 19c1c9cc7..bf463d815 100644 --- a/docs/source/plugin_list.rst +++ b/docs/source/plugin_list.rst @@ -17,15 +17,8 @@ automatically. Packages classified as inactive are excluded. always conduct your own quality assessment before incorporating any of these plugins into your own projects. -This list contains 0 plugins. +This list contains 7 plugins. -.. only:: not latex - -<<<<<<< Updated upstream - - -.. only:: latex -======= ========================== ==================================================================== ============== ========= ============== name summary last release status requires ========================== ==================================================================== ============== ========= ============== @@ -37,56 +30,3 @@ This list contains 0 plugins. :pypi:`pytask-stata` Execute do-files with Stata and pytask. Jan 23, 2023 4 - Beta pytask (>=0.3) :pypi:`pytask-vscode` Additional Logging for VS Code integration Nov 21, 2023 3 - Alpha pytask >=0.4.2 ========================== ==================================================================== ============== ========= ============== - -.. only:: latex - - - :pypi:`pytask-environment` - *last release*: Feb 10, 2023, - *status*: 4 - Beta, - *requires*: pytask (>=0.2) - - Detect changes in your pytask environment and abort a project build. - - :pypi:`pytask-julia` - *last release*: Oct 07, 2023, - *status*: 4 - Beta, - *requires*: pytask >=0.4.0 - - A Pytask plugin for Julia - - :pypi:`pytask-latex` - *last release*: Nov 30, 2023, - *status*: 4 - Beta, - *requires*: pytask >=0.4.0 - - Compile LaTeX documents with pytask. - - :pypi:`pytask-parallel` - *last release*: Jan 12, 2024, - *status*: 4 - Beta, - *requires*: pytask >=0.4.5 - - Parallelize the execution of tasks with pytask. - - :pypi:`pytask-r` - *last release*: Apr 20, 2024, - *status*: 4 - Beta, - *requires*: pytask>=0.4.5 - - Run R scripts with pytask. - - :pypi:`pytask-stata` - *last release*: Jan 23, 2023, - *status*: 4 - Beta, - *requires*: pytask (>=0.3) - - Execute do-files with Stata and pytask. - - :pypi:`pytask-vscode` - *last release*: Nov 21, 2023, - *status*: 3 - Alpha, - *requires*: pytask >=0.4.2 - - Additional Logging for VS Code integration ->>>>>>> Stashed changes diff --git a/scripts/update_plugin_list.py b/scripts/update_plugin_list.py index d7ca22076..0ba7b7a87 100644 --- a/scripts/update_plugin_list.py +++ b/scripts/update_plugin_list.py @@ -33,7 +33,6 @@ import datetime import pathlib import re -from textwrap import dedent from textwrap import indent from typing import Generator @@ -163,21 +162,6 @@ def _version_sort_key(version_string: str) -> packaging.version.Version: } -def _plugin_definitions(plugins: list[dict[str, str]]) -> Generator[str, None, None]: - """Return RST for the plugin list that fits better on a vertical page.""" - for plugin in plugins: - yield dedent( - f""" - {plugin['name']} - *last release*: {plugin["last release"]}, - *status*: {plugin["status"]}, - *requires*: {plugin["requires"]} - - {plugin["summary"]} - """ - ) - - def main() -> None: plugins = list(_iter_plugins()) @@ -187,15 +171,11 @@ def main() -> None: with plugin_list.open("w") as f: f.write(_FILE_HEAD) f.write(f"This list contains {len(plugins)} plugins.\n\n") - f.write(".. only:: not latex\n\n") assert wcwidth # reference library that must exist for tabulate to work plugin_table = tabulate.tabulate(plugins, headers="keys", tablefmt="rst") f.write(indent(plugin_table, " ")) - f.write("\n\n") - - f.write(".. only:: latex\n\n") - f.write(indent("".join(_plugin_definitions(plugins)), " ")) + f.write("\n") if __name__ == "__main__":