req2flatpak 0.1.0__tar.gz → 0.3.1__tar.gz

req2flatpak-0.3.1/COPYING

@@ -0,0 +1,7 @@
+Copyright 2022 johannesjh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

{req2flatpak-0.1.0 → req2flatpak-0.3.1}/PKG-INFO

@@ -1,18 +1,22 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: req2flatpak
-Version: 0.1.0
+Version: 0.3.1
 Summary: Generates a flatpak-builder build module for installing python packages defined in requirements.txt files.
 License: MIT
 Author: johannesjh
 Author-email: johannesjh@users.noreply.github.com
-Requires-Python: >=3.7.2,<4.0.0
+Requires-Python: >=3.8
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
-Provides-Extra: packaging
-Requires-Dist: packaging (>=21.3,<22.0); extra == "packaging"
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: yaml
+Requires-Dist: packaging (>=21.3,<22.0)
+Requires-Dist: pyyaml (>=6.0.1,<7.0.0) ; extra == "yaml"
 Description-Content-Type: text/x-rst
 
 req2flatpak
@@ -42,15 +46,19 @@ using pip.
 Getting Started
 ---------------
 
-Run ``pip install git+https://github.com/johannesjh/req2flatpak``
-to install the latest development version of req2flatpak.
+Install req2flatpak using pip (or any other python package installer),
+e.g., by running ``pip install req2flatpak``.
 
-It is possible to use req2flatpak from the commandline,
-as well as programmatically from a python script.
+Prepare a ``requirements.txt`` file with the packages that you want to install as part of a flatpak build.
+You need to specify exact versions for all the packages including their dependencies.
+(Various tools exist to help creating such a requirements file with fully resolved dependencies and frozen package versions;
+for example, you can use
+`pip-compile <https://pypi.org/project/pip-tools/>`_ or 
+`poetry export <https://pypi.org/project/poetry-plugin-export/>`_ to export a suitable ``requirements.txt`` file).
 
-Commandline usage means you can invoke req2flatpak’s commandline interface
-as follows, in order to generate a ``flatpak-builder`` build module
-from given python package requirements:
+Run req2flatpak. 
+For example, run this command to generate a ``flatpak-builder`` build module
+from your ``requirements.txt`` file:
 
 .. code:: bash
 
@@ -63,17 +71,17 @@ choose appropriate downloads for the specified target platforms,
 and generate a flatpak-builder build module.
 The module, if included in a flatpak-builder build manifest,
 will install the required packages using pip.
-
 The commandline option to define target platforms uses the format ``<pythonversion>-<architecture>``.
 To learn more about available commandline options,
 run ``req2flatpak.py --help``.
 
-Programmatic usage is also possible.
-This means you can invoke functionality from req2flatpak in your own python script,
-allowing you to tweak the desired behavior in many ways.
-The `documentation <https://johannesjh.github.io/req2flatpak/>`__
-describes req2flatpak's python api and includes code examples
-to help you get started quickly.
+Note that programmatic usage of req2flatpak is also possible.
+This means you can write a python script to invoke req2flatpak,
+which allows to tweak the desired behavior in many ways.
+
+Go read the `documentation <https://johannesjh.github.io/req2flatpak/>`__
+to learn more about req2flatpak's commandline and Python APIs.
+The documentation includes further examples to help you get started quickly.
 
 
 Documentation
@@ -113,28 +121,34 @@ A comparison will likely change over time.
 As in Oct, 2022, in my personal opinion (johannesjh),
 I see the following similarities and differences:
 
--  Both projects generate build modules for flatpak-builder.
--  Both projects consist of a single script file with minimal
+*  Both projects generate build modules for flatpak-builder.
+
+*  Both projects consist of a single script file with minimal
    dependencies, and are thus very easy to install.
--  ``flatpak-pip-generator`` resolves dependencies and freezes
+
+*  ``flatpak-pip-generator`` resolves dependencies and freezes
    dependency versions, whereas ``req2flatpak.py`` asks the user to
    provide a fully resolved list of dependencies with frozen dependency
    versions. Various tools exist which make this easy, e.g.,
    pip, pip-compile and poetry.
--  ``flatpak-pip-generator`` is older and thus likely to be more mature.
+
+*  ``flatpak-pip-generator`` is older and thus likely to be more mature.
    It supports more commandline options and probably has a more complete
    feature set.
--  ``req2flatpak.py`` is faster. The script itself runs faster because
+
+*  ``req2flatpak.py`` is faster. The script itself runs faster because
    it does not need to download package files in order to generate the
    build module. And the flatpak build runs faster because all packages
    (from the entire ``requirements.txt`` file) are installed in a single
    call to ``pip install``.
--  ``req2flatpak.py`` re-implements some functionality of pip. In
+
+*  ``req2flatpak.py`` re-implements some functionality of pip. In
    contrast, ``flatpak-pip-generator`` uses pip’s official
    functionality. Specifically, ``req2flatpak.py`` re-implements how pip
    queries available downloads from pypi and how pip chooses suitable
    downloads to match a given target platform.
--  ``req2flatpak.py`` prefers binary wheels, whereas
+
+*  ``req2flatpak.py`` prefers binary wheels, whereas
    ``flatpak-pip-generator`` prefers source packages.
 
 License
@@ -142,3 +156,38 @@ License
 
 req2flatpak is MIT-licensed, see the ``COPYING`` file.
 
+Changelog
+=========
+
+..
+   This changelog is written by hand.
+   Newest releases are added to the top of the file.
+
+
+v0.2 (2023-06-04) "Yaml"
+------------------------
+
+Highlight: req2flatpak can now generate yaml output.
+
+Features:
+
+- Adds yaml output.
+  It is now possible to generate yaml output by specifying a ``.yaml`` file extension
+  or by specifying the ``--yaml`` commandline option.
+
+Bugfixes:
+
+- Fixes sorting when architecture is None - `#34 <https://github.com/johannesjh/req2flatpak/pull/34>`_
+- Fixes exception handling with invalid platforms - `#39 <https://github.com/johannesjh/req2flatpak/pull/39>`_
+
+
+v0.1 (2022-12-23) "Initial Release"
+-----------------------------------
+
+Highlight: This is the initial release of req2flatpak.
+
+Features:
+
+- Generates a flatpak-builder build module for given python package requirements; the module will install the required packages as part of a flatpak build.
+- This initial release already comes with documentation, a clean code style, and automated tests that are run using continuous integration.
+

{req2flatpak-0.1.0 → req2flatpak-0.3.1}/README.rst

@@ -25,15 +25,19 @@ using pip.
 Getting Started
 ---------------
 
-Run ``pip install git+https://github.com/johannesjh/req2flatpak``
-to install the latest development version of req2flatpak.
+Install req2flatpak using pip (or any other python package installer),
+e.g., by running ``pip install req2flatpak``.
 
-It is possible to use req2flatpak from the commandline,
-as well as programmatically from a python script.
+Prepare a ``requirements.txt`` file with the packages that you want to install as part of a flatpak build.
+You need to specify exact versions for all the packages including their dependencies.
+(Various tools exist to help creating such a requirements file with fully resolved dependencies and frozen package versions;
+for example, you can use
+`pip-compile <https://pypi.org/project/pip-tools/>`_ or 
+`poetry export <https://pypi.org/project/poetry-plugin-export/>`_ to export a suitable ``requirements.txt`` file).
 
-Commandline usage means you can invoke req2flatpak’s commandline interface
-as follows, in order to generate a ``flatpak-builder`` build module
-from given python package requirements:
+Run req2flatpak. 
+For example, run this command to generate a ``flatpak-builder`` build module
+from your ``requirements.txt`` file:
 
 .. code:: bash
 
@@ -46,17 +50,17 @@ choose appropriate downloads for the specified target platforms,
 and generate a flatpak-builder build module.
 The module, if included in a flatpak-builder build manifest,
 will install the required packages using pip.
-
 The commandline option to define target platforms uses the format ``<pythonversion>-<architecture>``.
 To learn more about available commandline options,
 run ``req2flatpak.py --help``.
 
-Programmatic usage is also possible.
-This means you can invoke functionality from req2flatpak in your own python script,
-allowing you to tweak the desired behavior in many ways.
-The `documentation <https://johannesjh.github.io/req2flatpak/>`__
-describes req2flatpak's python api and includes code examples
-to help you get started quickly.
+Note that programmatic usage of req2flatpak is also possible.
+This means you can write a python script to invoke req2flatpak,
+which allows to tweak the desired behavior in many ways.
+
+Go read the `documentation <https://johannesjh.github.io/req2flatpak/>`__
+to learn more about req2flatpak's commandline and Python APIs.
+The documentation includes further examples to help you get started quickly.
 
 
 Documentation
@@ -96,28 +100,34 @@ A comparison will likely change over time.
 As in Oct, 2022, in my personal opinion (johannesjh),
 I see the following similarities and differences:
 
--  Both projects generate build modules for flatpak-builder.
--  Both projects consist of a single script file with minimal
+*  Both projects generate build modules for flatpak-builder.
+
+*  Both projects consist of a single script file with minimal
    dependencies, and are thus very easy to install.
--  ``flatpak-pip-generator`` resolves dependencies and freezes
+
+*  ``flatpak-pip-generator`` resolves dependencies and freezes
    dependency versions, whereas ``req2flatpak.py`` asks the user to
    provide a fully resolved list of dependencies with frozen dependency
    versions. Various tools exist which make this easy, e.g.,
    pip, pip-compile and poetry.
--  ``flatpak-pip-generator`` is older and thus likely to be more mature.
+
+*  ``flatpak-pip-generator`` is older and thus likely to be more mature.
    It supports more commandline options and probably has a more complete
    feature set.
--  ``req2flatpak.py`` is faster. The script itself runs faster because
+
+*  ``req2flatpak.py`` is faster. The script itself runs faster because
    it does not need to download package files in order to generate the
    build module. And the flatpak build runs faster because all packages
    (from the entire ``requirements.txt`` file) are installed in a single
    call to ``pip install``.
--  ``req2flatpak.py`` re-implements some functionality of pip. In
+
+*  ``req2flatpak.py`` re-implements some functionality of pip. In
    contrast, ``flatpak-pip-generator`` uses pip’s official
    functionality. Specifically, ``req2flatpak.py`` re-implements how pip
    queries available downloads from pypi and how pip chooses suitable
    downloads to match a given target platform.
--  ``req2flatpak.py`` prefers binary wheels, whereas
+
+*  ``req2flatpak.py`` prefers binary wheels, whereas
    ``flatpak-pip-generator`` prefers source packages.
 
 License

req2flatpak-0.3.1/docs/source/changelog.rst

@@ -0,0 +1,34 @@
+Changelog
+=========
+
+..
+   This changelog is written by hand.
+   Newest releases are added to the top of the file.
+
+
+v0.2 (2023-06-04) "Yaml"
+------------------------
+
+Highlight: req2flatpak can now generate yaml output.
+
+Features:
+
+- Adds yaml output.
+  It is now possible to generate yaml output by specifying a ``.yaml`` file extension
+  or by specifying the ``--yaml`` commandline option.
+
+Bugfixes:
+
+- Fixes sorting when architecture is None - `#34 <https://github.com/johannesjh/req2flatpak/pull/34>`_
+- Fixes exception handling with invalid platforms - `#39 <https://github.com/johannesjh/req2flatpak/pull/39>`_
+
+
+v0.1 (2022-12-23) "Initial Release"
+-----------------------------------
+
+Highlight: This is the initial release of req2flatpak.
+
+Features:
+
+- Generates a flatpak-builder build module for given python package requirements; the module will install the required packages as part of a flatpak build.
+- This initial release already comes with documentation, a clean code style, and automated tests that are run using continuous integration.

req2flatpak-0.3.1/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires      = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name        = "req2flatpak"
+version     = "0.3.1"
+description = "Generates a flatpak-builder build module for installing python packages defined in requirements.txt files."
+authors     = ["johannesjh <johannesjh@users.noreply.github.com>"]
+license     = "MIT"
+readme      = ["README.rst", "docs/source/changelog.rst"]
+
+[tool.poetry.scripts]
+req2flatpak = 'req2flatpak:main'
+
+[tool.poetry.dependencies]
+python    = ">=3.8"
+packaging = { version = "^21.3" }
+pyyaml    = { version = "^6.0.1", optional = true }
+
+[tool.poetry.extras]
+yaml = ["pyyaml"]
+
+[tool.poetry.group.lint.dependencies]
+ruff = "^0.11.2"
+
+# type stubs for mypy linting
+types-setuptools = "^65.5.0.2"
+types-pyyaml     = "^6.0.12.8"
+
+# [tool.poetry.group.tests.dependencies]
+pydocstyle = "<6.2"
+
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+sphinx                           = "^6.2.1"
+sphinx-argparse                  = "^0.4.0"
+sphinx-rtd-theme                 = "^2.0.0"
+sphinx-rtd-theme-github-versions = "^1.1"
+
+[tool.bandit]
+exclude_dirs = ['tests']

{req2flatpak-0.1.0 → req2flatpak-0.3.1}/req2flatpak.py

@@ -2,7 +2,7 @@
 
 # req2flatpak is MIT-licensed.
 #
-# Copyright 2022 johannesjh
+# Copyright 2022-2024 johannesjh
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -43,11 +43,11 @@ import sys
 import urllib.request
 from contextlib import nullcontext, suppress
 from dataclasses import asdict, dataclass, field
+from importlib import metadata
 from itertools import product
 from typing import (
     Any,
     Dict,
-    FrozenSet,
     Generator,
     Hashable,
     Iterable,
@@ -60,10 +60,16 @@ from typing import (
 )
 from urllib.parse import urlparse
 
-import pkg_resources
+import packaging.requirements as packaging_reqs
+import packaging.tags
+from packaging.utils import parse_wheel_filename
 
 logger = logging.getLogger(__name__)
 
+try:
+    import yaml
+except ImportError:
+    yaml = None  # type: ignore
 
 # =============================================================================
 # Helper functions / semi vendored code
@@ -73,7 +79,6 @@ try:
     # added with py 3.8
     from functools import cached_property  # type: ignore[attr-defined]
 except ImportError:
-
     # Inspired by the implementation in the standard library
     # pylint: disable=invalid-name,too-few-public-methods
     class cached_property:  # type: ignore[no-redef]
@@ -102,65 +107,18 @@ except ImportError:
             return val
 
 
-try:
-    # use packaging.tags functionality if available
-    from packaging.utils import parse_wheel_filename
-
-    def tags_from_wheel_filename(filename: str) -> Set[str]:
-        """
-        Parses a wheel filename into a list of compatible platform tags.
-
-        Implemented using functionality from ``packaging.utils.parse_wheel_filename``.
-        """
-        _, _, _, tags = parse_wheel_filename(filename)
-        return {str(tag) for tag in tags}
+class InvalidWheelFilename(Exception):
+    """An invalid wheel filename was found, users should refer to PEP 427."""
 
-except ModuleNotFoundError:
-    # fall back to a local implementation
-    # that is heavily inspired by / almost vendored from the `packaging` package:
-    def tags_from_wheel_filename(filename: str) -> Set[str]:
-        """
-        Parses a wheel filename into a list of compatible platform tags.
 
-        Implemented as (semi-)vendored functionality in req2flatpak.
-        """
-        InvalidWheelFilename = Exception
-        Tag = Tuple[str, str, str]
-
-        # the following code is based on packaging.tags.parse_tag,
-        # it is needed for the parse_wheel_filename function:
-        def parse_tag(tag: str) -> FrozenSet[Tag]:
-            tags: Set[Tag] = set()
-            interpreters, abis, platforms = tag.split("-")
-            for interpreter in interpreters.split("."):
-                for abi in abis.split("."):
-                    for platform_ in platforms.split("."):
-                        tags.add((interpreter, abi, platform_))
-            return frozenset(tags)
-
-        # the following code is based on packaging.utils.parse_wheel_filename:
-        # pylint: disable=redefined-outer-name
-        def parse_wheel_filename(
-            wheel_filename: str,
-        ) -> Iterable[Tag]:
-            if not wheel_filename.endswith(".whl"):
-                raise InvalidWheelFilename(
-                    "Error parsing wheel filename: "
-                    "Invalid wheel filename (extension must be '.whl'): "
-                    f"{wheel_filename}"
-                )
-            wheel_filename = wheel_filename[:-4]
-            dashes = wheel_filename.count("-")
-            if dashes not in (4, 5):
-                raise InvalidWheelFilename(
-                    "Error parsing wheel filename: "
-                    "Invalid wheel filename (wrong number of parts): "
-                    f"{wheel_filename}"
-                )
-            parts = wheel_filename.split("-", dashes - 2)
-            return parse_tag(parts[-1])
+def tags_from_wheel_filename(filename: str) -> Set[str]:
+    """
+    Parses a wheel filename into a list of compatible platform tags.
 
-        return {"-".join(tag_tuple) for tag_tuple in parse_wheel_filename(filename)}
+    Implemented using functionality from ``packaging.utils.parse_wheel_filename``.
+    """
+    _, _, _, tags = parse_wheel_filename(filename)
+    return {str(tag) for tag in tags}
 
 
 # =============================================================================
@@ -227,6 +185,17 @@ class Download(Requirement):
                 return "aarch64"
         return None
 
+    def __lt__(self, other):
+        """Makes this class sortable."""
+        # Note: Implementing __lt__ is sufficient to make a class sortable,
+        # see, e.g., https://stackoverflow.com/a/7152796
+
+        def sort_keys(download: Download) -> Tuple[str, str, str]:
+            """A tuple of package, version and architecture is used as key for sorting."""
+            return download.package, download.version, download.arch or ""
+
+        return sort_keys(self) < sort_keys(other)
+
 
 @dataclass(frozen=True)
 class Release(Requirement):
@@ -254,17 +223,8 @@ class PlatformFactory:
 
     @staticmethod
     def _get_current_python_tags() -> List[str]:
-        try:
-            # pylint: disable=import-outside-toplevel
-            import packaging.tags
-
-            tags = [str(tag) for tag in packaging.tags.sys_tags()]
-            return tags
-        except ModuleNotFoundError as e:
-            logger.warning(
-                'Error trying to import the "packaging" package.', exc_info=e
-            )
-            return []
+        tags = [str(tag) for tag in packaging.tags.sys_tags()]
+        return tags
 
     @classmethod
     def from_current_interpreter(cls) -> Platform:
@@ -308,7 +268,7 @@ class PlatformFactory:
 
     @classmethod
     def from_python_version_and_arch(
-        cls, minor_version: int = None, arch="x86_64"
+        cls, minor_version: Optional[int] = None, arch="x86_64"
     ) -> Platform:
         """
         Returns a platform object that roughly describes a cpython installation on linux.
@@ -333,7 +293,7 @@ class PlatformFactory:
 
     @classmethod
     def _cp3_linux_tags(
-        cls, minor_version: int = None, arch="x86_64"
+        cls, minor_version: Optional[int] = None, arch="x86_64"
     ) -> Generator[str, None, None]:
         """Yields python platform tags for cpython3 on linux."""
         # pylint: disable=too-many-branches
@@ -414,27 +374,32 @@ class RequirementsParser:
     resolve dependencies.
     """
 
-    # based on: https://stackoverflow.com/a/59971236
-    # using functionality from pkg_resources.parse_requirements
-
     @classmethod
     def parse_string(cls, requirements_txt: str) -> List[Requirement]:
         """Parses requirements.txt string content into a list of Requirement objects."""
 
-        def validate_requirement(req: pkg_resources.Requirement) -> None:
-            assert (
-                len(req.specs) == 1
-            ), "Error parsing requirements: A single version number must be specified."
-            assert (
-                req.specs[0][0] == "=="
-            ), "Error parsing requirements: The exact version must specified as 'package==version'."
+        def validate_requirement(req: packaging_reqs.Requirement) -> None:
+            assert len(req.specifier) == 1, (
+                "Error parsing requirements: A single version number must be specified."
+            )
+            assert list(req.specifier)[0].operator == "==", (
+                "Error parsing requirements: The exact version must specified as 'package==version'."
+            )
 
-        def make_requirement(req: pkg_resources.Requirement) -> Requirement:
+        def make_requirement(req: packaging_reqs.Requirement) -> Requirement:
             validate_requirement(req)
-            return Requirement(package=req.project_name, version=req.specs[0][1])
+            return Requirement(package=req.name, version=list(req.specifier)[0].version)
+
+        requirements = []
+        for line in requirements_txt.splitlines():
+            if not (line := line.strip()):
+                continue
+            if line.startswith("#"):
+                continue
+            req = packaging_reqs.Requirement(line)
+            requirements.append(make_requirement(req))
 
-        reqs = pkg_resources.parse_requirements(requirements_txt)
-        return [make_requirement(req) for req in reqs]
+        return requirements
 
     @classmethod
     def parse_file(cls, file) -> List[Requirement]:
@@ -485,6 +450,8 @@ class PypiClient:
         url = f"https://pypi.org/pypi/{req.package}/{req.version}/json"
         json_string = cls._query(url)
         json_dict = json.loads(json_string)
+        if not json_dict["urls"]:
+            raise RuntimeError(f"Release {req} has no URLs: maybe too old?")
         return Release(
             package=req.package,
             version=req.version,
@@ -537,9 +504,7 @@ class DownloadChooser:
         preferred downloads are returned first.
         """
         cache = set()
-        for (platform_tag, download) in product(
-            platform.python_tags, release.downloads
-        ):
+        for platform_tag, download in product(platform.python_tags, release.downloads):
             if download in cache:
                 continue
             if wheels_only and not download.is_wheel:
@@ -584,14 +549,18 @@ class DownloadChooser:
 class FlatpakGenerator:
     """Provides methods for generating a flatpak-builder build module."""
 
+    pip_install_template: str = (
+        "pip3 install --verbose --exists-action=i "
+        '--no-index --find-links="file://${PWD}" '
+        "--prefix=${FLATPAK_DEST} --no-build-isolation "
+    )
+
     @staticmethod
     def build_module(
         requirements: Iterable[Requirement],
         downloads: Iterable[Download],
         module_name="python3-package-installation",
-        pip_install_template: str = "pip3 install --verbose --exists-action=i "
-        '--no-index --find-links="file://${PWD}" '
-        "--prefix=${FLATPAK_DEST} --no-build-isolation ",
+        pip_install_template: str = pip_install_template,
     ) -> dict:
         """Generates a build module for inclusion in a flatpak-builder build manifest."""
 
@@ -606,10 +575,7 @@ class FlatpakGenerator:
             return source
 
         def sources(downloads: Iterable[Download]) -> List[dict]:
-            sorted_downloads = sorted(
-                downloads, key=lambda d: (d.package, d.version, d.arch)
-            )
-            return [source(download) for download in sorted_downloads]
+            return [source(download) for download in sorted(downloads)]
 
         return {
             "name": module_name,
@@ -623,12 +589,30 @@ class FlatpakGenerator:
     @classmethod
     def build_module_as_str(cls, *args, **kwargs) -> str:
         """
-        Generates a build module for inclusion in a flatpak-builder build manifest.
+        Generate JSON build module for inclusion in a flatpak-builder build manifest.
 
         The args and kwargs are the same as in
         :py:meth:`~req2flatpak.FlatpakGenerator.build_module`
         """
-        return json.dumps(cls.build_module(*args, **kwargs), indent=2)
+        return json.dumps(cls.build_module(*args, **kwargs), indent=4)
+
+    @classmethod
+    def build_module_as_yaml_str(cls, *args, **kwargs) -> str:
+        """
+        Generate YAML build module for inclusion in a flatpak-builder build manifest.
+
+        The args and kwargs are the same as in
+        :py:meth:`~req2flatpak.FlatpakGenerator.build_module`
+        """
+        # optional dependency, not imported at top
+        if not yaml:
+            raise ImportError(
+                "Package `pyyaml` has to be installed for the yaml format."
+            )
+
+        return yaml.dump(
+            cls.build_module(*args, **kwargs), default_flow_style=False, sort_keys=False
+        )
 
 
 # =============================================================================
@@ -665,12 +649,22 @@ def cli_parser() -> argparse.ArgumentParser:
         default=False,
         help="Uses a persistent cache when querying pypi.",
     )
+    parser.add_argument(
+        "--yaml",
+        action="store_true",
+        help="Write YAML instead of the default JSON.  Needs the 'pyyaml' package.",
+    )
+
     parser.add_argument(
         "--outfile",
         "-o",
         nargs="?",
         type=argparse.FileType("w"),
         default=sys.stdout,
+        help="""
+            By default, writes JSON but specify a '.yaml' extension and YAML
+            will be written instead, provided you have the 'pyyaml' package.
+        """,
     )
     parser.add_argument(
         "--platform-info",
@@ -687,7 +681,7 @@ def cli_parser() -> argparse.ArgumentParser:
     return parser
 
 
-def main():
+def main():  # pylint: disable=too-many-branches
     """Main function that provides req2flatpak's commandline interface."""
 
     # process commandline arguments
@@ -695,19 +689,33 @@ def main():
     options = parser.parse_args()
 
     # stream output to a file or to stdout
-    output_stream = options.outfile if hasattr(options.outfile, "write") else sys.stdout
+    if hasattr(options.outfile, "write"):
+        output_stream = options.outfile
+        if pathlib.Path(output_stream.name).suffix.casefold() in (".yaml", ".yml"):
+            options.yaml = True
+    else:
+        output_stream = sys.stdout
+
+    if options.yaml and not yaml:
+        parser.error(
+            "Outputing YAML requires 'pyyaml' package: try 'pip install pyyaml'"
+        )
 
     # print platform info if requested, and exit
     if options.platform_info:
-        json.dump(
-            asdict(PlatformFactory.from_current_interpreter()), output_stream, indent=4
-        )
+        info = asdict(PlatformFactory.from_current_interpreter())
+        if options.yaml:
+            yaml.dump(info, output_stream, default_flow_style=False, sort_keys=False)
+        else:
+            json.dump(info, output_stream, indent=4)
         parser.exit()
 
     # print installed packages if requested, and exit
     if options.installed_packages:
         # pylint: disable=not-an-iterable
-        pkgs = {p.key: p.version for p in pkg_resources.working_set}
+        pkgs = {
+            p.metadata["Name"]: p.metadata["Version"] for p in metadata.distributions()
+        }
         for pkg, version in pkgs.items():
             print(f"{pkg}=={version}", file=output_stream)
         parser.exit()
@@ -755,13 +763,24 @@ def main():
         DownloadChooser.wheel_or_sdist(release, platform)
         for release in releases
         for platform in platforms
+        if platform
     }
 
     # generate flatpak-builder build module
-    build_module = FlatpakGenerator.build_module(requirements, downloads)
-
-    # write output
-    json.dump(build_module, output_stream, indent=4)
+    if options.yaml:
+        try:
+            name = pathlib.Path(__file__).name
+        except NameError:
+            name = "req2flatpak"
+        output_stream.write(f"# Generated by {name} {' '.join(sys.argv[1:])}\n")
+        output_stream.write(
+            FlatpakGenerator.build_module_as_yaml_str(requirements, downloads)
+        )
+    else:
+        # write json
+        output_stream.write(
+            FlatpakGenerator.build_module_as_str(requirements, downloads)
+        )
 
 
 if __name__ == "__main__":

req2flatpak-0.1.0/pyproject.toml

@@ -1,69 +0,0 @@
-[tool.poetry]
-name = "req2flatpak"
-version = "0.1.0"
-description = "Generates a flatpak-builder build module for installing python packages defined in requirements.txt files."
-authors = ["johannesjh <johannesjh@users.noreply.github.com>"]
-license = "MIT"
-readme = "README.rst"
-
-[tool.poetry.scripts]
-req2flatpak = 'req2flatpak:main'
-
-[tool.poetry.dependencies]
-python = "^3.7.2"
-packaging = { version = "^21.3", optional = true }
-
-[tool.poetry.group.lint.dependencies]
-pylama = { extras = [
-    "mypy",
-    "pylint",
-    "eradicate",
-    "toml",
-], version = "^8.4.1" }
-bandit = { extras = ["toml"], version = "^1.7.4" }
-types-setuptools = "^65.5.0.2" # type stubs for mypy linting
-
-# [tool.poetry.group.tests.dependencies]
-
-[tool.poetry.group.docs]
-optional = true
-
-[tool.poetry.group.docs.dependencies]
-sphinx = "^5.3.0"
-sphinx-argparse = "^0.3.2"
-sphinx-rtd-theme-github-versions = "^1.1"
-
-[tool.poetry.extras]
-packaging = ["packaging"]
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.isort]
-profile = "black"
-skip_gitignore = true
-
-[tool.pylama]
-max_line_length = 88
-concurrent = true
-linters = "pycodestyle,pydocstyle,pyflakes,pylint,eradicate,mypy"
-
-[tool.pylama.linter.pycodestyle]
-ignore = "W503,E203,E501"
-
-# [tool.pycodestyle] -> see setup.cfg
-
-[tool.pylama.linter.pydocstyle]
-ignore = "D202,D203,D205,D401,D212"
-
-[tool.pydocstyle]
-ignore = ["D202", "D203", "D205", "D401", "D212"]
-
-[tool.pylint]
-format.max-line-length = 88
-main.disable = ["C0301"]            # ignore line-too-long
-basic.good-names = ["e", "f", "py"]
-
-[tool.bandit]
-exclude_dirs = ['tests']

req2flatpak-0.1.0/setup.py

@@ -1,29 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-modules = \
-['req2flatpak']
-extras_require = \
-{'packaging': ['packaging>=21.3,<22.0']}
-
-entry_points = \
-{'console_scripts': ['req2flatpak = req2flatpak:main']}
-
-setup_kwargs = {
-    'name': 'req2flatpak',
-    'version': '0.1.0',
-    'description': 'Generates a flatpak-builder build module for installing python packages defined in requirements.txt files.',
-    'long_description': "req2flatpak\n===========\n\n.. inclusion-marker-do-not-remove\n\n``req2flatpak`` is a script to convert python package requirements\nto a flatpak-builder build module.\nThe module will install the required python packages\nas part of a flatpak build.\n\n\nIntended Use\n------------\n\nreq2flatpak is for programmers\nwho want to package a python application using flatpak.\n\nThe req2flatpak script takes python package requirements as input, e.g., as\n``requirements.txt`` file. It allows to specify the target platform’s\npython version and architecture. The script outputs an automatically\ngenerated ``flatpak-builder`` build module. The build module, if included\ninto a flatpak-builder build manifest, will install the python packages\nusing pip.\n\nGetting Started\n---------------\n\nRun ``pip install git+https://github.com/johannesjh/req2flatpak``\nto install the latest development version of req2flatpak.\n\nIt is possible to use req2flatpak from the commandline,\nas well as programmatically from a python script.\n\nCommandline usage means you can invoke req2flatpak’s commandline interface\nas follows, in order to generate a ``flatpak-builder`` build module\nfrom given python package requirements:\n\n.. code:: bash\n\n   ./req2flatpak.py --requirements-file requirements.txt --target-platforms 310-x86_64 310-aarch64\n\nWhen invoked like this, req2flatpak will\nread the requirements file,\nquery pypi about available downloads for the requirements,\nchoose appropriate downloads for the specified target platforms,\nand generate a flatpak-builder build module.\nThe module, if included in a flatpak-builder build manifest,\nwill install the required packages using pip.\n\nThe commandline option to define target platforms uses the format ``<pythonversion>-<architecture>``.\nTo learn more about available commandline options,\nrun ``req2flatpak.py --help``.\n\nProgrammatic usage is also possible.\nThis means you can invoke functionality from req2flatpak in your own python script,\nallowing you to tweak the desired behavior in many ways.\nThe `documentation <https://johannesjh.github.io/req2flatpak/>`__\ndescribes req2flatpak's python api and includes code examples\nto help you get started quickly.\n\n\nDocumentation\n-------------\n\nSee https://johannesjh.github.io/req2flatpak/\n\n\nContributing\n------------\n\nreq2flatpak is developed in an open-source, community-driven way, as a\nvoluntary effort in the authors’ free time.\n\nAll contributions are greatly appreciated… pull requests are welcome,\nand so are bug reports and suggestions for improvement.\nSee req2flatpak’s documentation for how to set up a development environment\nand how to contribute back to req2flatpak.\n\nRelated Work\n------------\n\nThe\n`flatpak-pip-generator <https://github.com/flatpak/flatpak-builder-tools/blob/master/pip/flatpak-pip-generator>`__\nscript is very similar to this project. Both scripts basically serve the same purpose,\nand this project took a lot of inspiration from\nflatpak-pip-generator. In fact, this project was created when we\ndiscussed feature request\n`#296 <https://github.com/flatpak/flatpak-builder-tools/issues/296>`__\nin flatpak-pip-generator. A prototype followed from this feature\nrequest, and since it was written from scratch, the prototype became\nthis separate project.\n\nComparison between ``flatpak-pip-generator`` and ``req2flatpak.py``:\nEach of the two projects has its own benefits.\nA comparison will likely change over time.\nAs in Oct, 2022, in my personal opinion (johannesjh),\nI see the following similarities and differences:\n\n-  Both projects generate build modules for flatpak-builder.\n-  Both projects consist of a single script file with minimal\n   dependencies, and are thus very easy to install.\n-  ``flatpak-pip-generator`` resolves dependencies and freezes\n   dependency versions, whereas ``req2flatpak.py`` asks the user to\n   provide a fully resolved list of dependencies with frozen dependency\n   versions. Various tools exist which make this easy, e.g.,\n   pip, pip-compile and poetry.\n-  ``flatpak-pip-generator`` is older and thus likely to be more mature.\n   It supports more commandline options and probably has a more complete\n   feature set.\n-  ``req2flatpak.py`` is faster. The script itself runs faster because\n   it does not need to download package files in order to generate the\n   build module. And the flatpak build runs faster because all packages\n   (from the entire ``requirements.txt`` file) are installed in a single\n   call to ``pip install``.\n-  ``req2flatpak.py`` re-implements some functionality of pip. In\n   contrast, ``flatpak-pip-generator`` uses pip’s official\n   functionality. Specifically, ``req2flatpak.py`` re-implements how pip\n   queries available downloads from pypi and how pip chooses suitable\n   downloads to match a given target platform.\n-  ``req2flatpak.py`` prefers binary wheels, whereas\n   ``flatpak-pip-generator`` prefers source packages.\n\nLicense\n-------\n\nreq2flatpak is MIT-licensed, see the ``COPYING`` file.\n",
-    'author': 'johannesjh',
-    'author_email': 'johannesjh@users.noreply.github.com',
-    'maintainer': 'None',
-    'maintainer_email': 'None',
-    'url': 'None',
-    'py_modules': modules,
-    'extras_require': extras_require,
-    'entry_points': entry_points,
-    'python_requires': '>=3.7.2,<4.0.0',
-}
-
-
-setup(**setup_kwargs)