req2flatpak 0.2.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.2.0 → req2flatpak-0.3.1}/PKG-INFO

@@ -1,21 +1,22 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: req2flatpak
-Version: 0.2.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
 Classifier: Programming Language :: Python :: 3.11
-Provides-Extra: packaging
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: yaml
-Requires-Dist: packaging (>=21.3,<22.0) ; extra == "packaging"
-Requires-Dist: pyyaml (>=6.0,<7.0) ; 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
@@ -45,15 +46,19 @@ using pip.
 Getting Started
 ---------------
 
-Run ``pip install req2flatpak``
-to install the latest release 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
 
@@ -66,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

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

@@ -25,15 +25,19 @@ using pip.
 Getting Started
 ---------------
 
-Run ``pip install req2flatpak``
-to install the latest release 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

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.2.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,7 +60,9 @@ 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__)
 
@@ -109,64 +111,14 @@ class InvalidWheelFilename(Exception):
     """An invalid wheel filename was found, users should refer to PEP 427."""
 
 
-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}
-
-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.
-        """
-        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}
 
 
 # =============================================================================
@@ -271,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:
@@ -431,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)
 
-        reqs = pkg_resources.parse_requirements(requirements_txt)
-        return [make_requirement(req) for req in reqs]
+        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))
+
+        return requirements
 
     @classmethod
     def parse_file(cls, file) -> List[Requirement]:
@@ -502,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,
@@ -599,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."""
 
@@ -759,7 +713,9 @@ def main():  # pylint: disable=too-many-branches
     # 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()

req2flatpak-0.2.0/pyproject.toml

@@ -1,76 +0,0 @@
-[build-system]
-requires      = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.poetry]
-name        = "req2flatpak"
-version     = "0.2.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", "docs/source/changelog.rst"]
-
-[tool.poetry.scripts]
-req2flatpak = 'req2flatpak:main'
-
-[tool.poetry.dependencies]
-python    = "^3.7.2"
-packaging = { version = "^21.3", optional = true }
-pyyaml    = { version = "^6.0", optional = true }
-
-[tool.poetry.extras]
-packaging = ["packaging"]
-yaml      = ["pyyaml"]
-
-[tool.poetry.group.lint.dependencies]
-pylama = { extras = [
-    "mypy",
-    "pylint",
-    "eradicate",
-    "toml",
-], version = "^8.4.1" }
-bandit = { extras = ["toml"], version = "^1.7.4" }
-
-# 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                           = "^5.3.0"
-sphinx-argparse                  = "^0.4.0"
-sphinx-rtd-theme                 = "^1.2.0"
-sphinx-rtd-theme-github-versions = "^1.1"
-
-[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']