extreqs 1.2.0__tar.gz → 1.3.0__tar.gz

extreqs-1.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022, Chris L. Barnes
+
+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.

extreqs-1.3.0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: extreqs
+Version: 1.3.0
+Summary: Parse python requirements.txt files into setuptools extras
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Dist: requirements-parser>=0.13.1
+Requires-Python: >=3.10, <4.0
+Description-Content-Type: text/markdown
+
+# extreqs
+
+Parse python requirements.txt files into setuptools extras.
+
+`extreqs` is a build-time dependency used in projects with a `requirements.txt` and a `setup.py`,
+where the `setup.py` reads the `requirements.txt` to determine the runtime dependencies.
+
+## Do not use this package
+
+`extreqs` was written in a simpler but much worse time for python packaging.
+Historically, `setup.cfg` or `setup.py` was used to specify runtime dependencies.
+Applications were supposed to use strict version constraints,
+and libraries permissive version constraints.
+
+For CI and development purposes,
+it was convenient to use `requirements.txt` files to fix specific versions,
+or to specify additional dependencies used at development time and not at runtime.
+
+This meant manually syncing two files, which is a pain.
+So the intended walls between the use of `requirements.txt` and `setup.py` started to break down, and a pattern emerged of parsing your single-source-of-truth `requirements.txt` to feed into your `setup.py`.
+
+`extreqs` was developed to fill the need of describing ["extras"](https://stackoverflow.com/questions/52474931/what-is-extra-in-pypi-dependency) while still maintaining `requirements.txt` as your single source of truth.
+`extreqs` was always intended primarily to support application development,
+but could be used for library development as well as a bridge (or crutch?) for people who preferred using `requirements.txt` for specifying dependencies.
+
+Today, various development tools, most notably [`uv`](https://docs.astral.sh/uv/), handle lock files for you based on the canonical `pyproject.toml` dependency list, which also handles extras and groups (for development dependencies).
+Those tools, in particular `uv`, should be used instead.
+
+This package is maintained for legacy purposes.
+
+## Usage
+
+`extreqs` looks for special comments (`#extra:`) in your requirements files.
+Note the lack of space after the `#`!
+Anything which follows that (until the end of line, or another `#`) is treated as a whitespace-separated list of extras.
+For example, `#extra: dev test doc` marks dependencies belonging to the `dev`, `test`, and `doc` extras.
+
+If the `#extra:` comment is on the same line as (following) a dependency, then just that dependency belongs to that extra.
+If the `#extra:` comment is on a line on its own, all dependencies below it belong to that extra, until the next `#extra:` line.
+
+For example:
+
+```txt
+# requirements.txt
+dep1
+dep2  #extra: e1
+
+#extra: e2
+dep3
+
+#extra: e3  # you can still have freeform comments!
+dep4  #extra: e4 e5
+dep5
+```
+
+would be parsed into
+
+```python
+install_requires = ["dep1"]
+extras_require = {
+    "e1": ["dep2"],
+    "e2": ["dep3"],
+    "e3": ["dep4", "dep5"],
+    "e4": ["dep4"],
+    "e5": ["dep4"],
+}
+```
+
+Additionally, entire files can belong to a particular extra.
+
+Note that python extras are not smart enough to deal with dependencies which belong only to _combinations_ of extras, or _negative_ extras: a dependency which belongs to multiple extras (given by the context of the file, block, or line) just belongs to multiple extras.
+This is a limitation of python packaging and cannot be addressed here.
+
+In your `setup.py`:
+
+```python
+#!/usr/bin/env python3
+"""setup.py"""
+from pathlib import Path
+
+from extreqs import parse_requirements_files_dict
+from setuptools import setup
+
+here = Path(__file__).resolve().parent
+
+req_kwargs = parse_requirements_files_dict(
+    # files without an extra context are in *args
+    here / "requirements.txt",
+    # files with an extra context are in **kwargs
+    optional=here / "requirements-optional.txt",
+)
+
+setup(
+    name="my_package",
+    ...
+    **req_kwargs,
+    ...
+)
+```
+
+`extreqs` is an install-time dependency, and so must be added to your `pyproject.toml`:
+
+```toml
+# pyproject.toml
+[build-system]
+requires = ["setuptools", "extreqs"]
+build-backend = "setuptools.build_meta"
+```
+
+Look out for dependency specifiers which are accepted by pip, but not by setuptools (e.g. editable install `-e` or references to other requirement files `-r`).
+
+## Development
+
+Contributions are welcome, although any broadening of extreqs' scope is unlikely to be accepted - raise an issue first!
+
+Releases are made like this
+
+```sh
+# commit all your changes, push, and ensure that CI passes
+git add .
+git commit -m "Prepare for a new version"
+git push
+
+# bump the version
+uv version --bump minor
+
+# commit the version bump
+git add .
+git commit -m "Bump to version $(uv version --short)"
+
+# tag the commit
+git tag -a "v$(uv version --short)" -m "New feature X"
+
+# push to CI, which will do the releasing
+git push --follow-tags
+```

extreqs-1.3.0/README.md

@@ -0,0 +1,136 @@
+# extreqs
+
+Parse python requirements.txt files into setuptools extras.
+
+`extreqs` is a build-time dependency used in projects with a `requirements.txt` and a `setup.py`,
+where the `setup.py` reads the `requirements.txt` to determine the runtime dependencies.
+
+## Do not use this package
+
+`extreqs` was written in a simpler but much worse time for python packaging.
+Historically, `setup.cfg` or `setup.py` was used to specify runtime dependencies.
+Applications were supposed to use strict version constraints,
+and libraries permissive version constraints.
+
+For CI and development purposes,
+it was convenient to use `requirements.txt` files to fix specific versions,
+or to specify additional dependencies used at development time and not at runtime.
+
+This meant manually syncing two files, which is a pain.
+So the intended walls between the use of `requirements.txt` and `setup.py` started to break down, and a pattern emerged of parsing your single-source-of-truth `requirements.txt` to feed into your `setup.py`.
+
+`extreqs` was developed to fill the need of describing ["extras"](https://stackoverflow.com/questions/52474931/what-is-extra-in-pypi-dependency) while still maintaining `requirements.txt` as your single source of truth.
+`extreqs` was always intended primarily to support application development,
+but could be used for library development as well as a bridge (or crutch?) for people who preferred using `requirements.txt` for specifying dependencies.
+
+Today, various development tools, most notably [`uv`](https://docs.astral.sh/uv/), handle lock files for you based on the canonical `pyproject.toml` dependency list, which also handles extras and groups (for development dependencies).
+Those tools, in particular `uv`, should be used instead.
+
+This package is maintained for legacy purposes.
+
+## Usage
+
+`extreqs` looks for special comments (`#extra:`) in your requirements files.
+Note the lack of space after the `#`!
+Anything which follows that (until the end of line, or another `#`) is treated as a whitespace-separated list of extras.
+For example, `#extra: dev test doc` marks dependencies belonging to the `dev`, `test`, and `doc` extras.
+
+If the `#extra:` comment is on the same line as (following) a dependency, then just that dependency belongs to that extra.
+If the `#extra:` comment is on a line on its own, all dependencies below it belong to that extra, until the next `#extra:` line.
+
+For example:
+
+```txt
+# requirements.txt
+dep1
+dep2  #extra: e1
+
+#extra: e2
+dep3
+
+#extra: e3  # you can still have freeform comments!
+dep4  #extra: e4 e5
+dep5
+```
+
+would be parsed into
+
+```python
+install_requires = ["dep1"]
+extras_require = {
+    "e1": ["dep2"],
+    "e2": ["dep3"],
+    "e3": ["dep4", "dep5"],
+    "e4": ["dep4"],
+    "e5": ["dep4"],
+}
+```
+
+Additionally, entire files can belong to a particular extra.
+
+Note that python extras are not smart enough to deal with dependencies which belong only to _combinations_ of extras, or _negative_ extras: a dependency which belongs to multiple extras (given by the context of the file, block, or line) just belongs to multiple extras.
+This is a limitation of python packaging and cannot be addressed here.
+
+In your `setup.py`:
+
+```python
+#!/usr/bin/env python3
+"""setup.py"""
+from pathlib import Path
+
+from extreqs import parse_requirements_files_dict
+from setuptools import setup
+
+here = Path(__file__).resolve().parent
+
+req_kwargs = parse_requirements_files_dict(
+    # files without an extra context are in *args
+    here / "requirements.txt",
+    # files with an extra context are in **kwargs
+    optional=here / "requirements-optional.txt",
+)
+
+setup(
+    name="my_package",
+    ...
+    **req_kwargs,
+    ...
+)
+```
+
+`extreqs` is an install-time dependency, and so must be added to your `pyproject.toml`:
+
+```toml
+# pyproject.toml
+[build-system]
+requires = ["setuptools", "extreqs"]
+build-backend = "setuptools.build_meta"
+```
+
+Look out for dependency specifiers which are accepted by pip, but not by setuptools (e.g. editable install `-e` or references to other requirement files `-r`).
+
+## Development
+
+Contributions are welcome, although any broadening of extreqs' scope is unlikely to be accepted - raise an issue first!
+
+Releases are made like this
+
+```sh
+# commit all your changes, push, and ensure that CI passes
+git add .
+git commit -m "Prepare for a new version"
+git push
+
+# bump the version
+uv version --bump minor
+
+# commit the version bump
+git add .
+git commit -m "Bump to version $(uv version --short)"
+
+# tag the commit
+git tag -a "v$(uv version --short)" -m "New feature X"
+
+# push to CI, which will do the releasing
+git push --follow-tags
+```

extreqs-1.3.0/pyproject.toml

@@ -0,0 +1,31 @@
+[project]
+name = "extreqs"
+version = "1.3.0"
+description = "Parse python requirements.txt files into setuptools extras"
+requires-python = ">=3.10,<4.0"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+]
+dependencies = ["requirements-parser>=0.13.1"]
+
+[build-system]
+requires = ["uv_build>=0.13.4,<0.14"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "mypy>=2.4",
+    "pdoc>=16",
+    "pytest>=9.1",
+    "ruff>=0.17.1",
+]

extreqs-1.2.0/pyproject.toml → extreqs-1.3.0/pyproject.toml.orig

@@ -1,31 +1,34 @@
 [project]
 name = "extreqs"
-version = "1.2.0"
+version = "1.3.0"
 description = "Parse python requirements.txt files into setuptools extras"
 requires-python = ">=3.10,<4.0"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
 classifiers = [
     "Development Status :: 3 - Alpha",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
 ]
 
 dependencies = [
-    "requirements-parser>=0.13.0",
+    "requirements-parser>=0.13.1",
 ]
 
 [build-system]
-requires = ["uv_build>=0.10.0,<0.11.0"]
+requires = ["uv_build>=0.13.4,<0.14"]
 build-backend = "uv_build"
 
 [dependency-groups]
 dev = [
-    "mypy>=1.19.1",
-    "pdoc3>=0.11.6",
-    "pytest>=9.0.2",
-    "ruff>=0.15.0",
+    "mypy>=2.4",
+    "pdoc>=16",
+    "pytest>=9.1",
+    "ruff>=0.17.1",
 ]

{extreqs-1.2.0 → extreqs-1.3.0}/src/extreqs/__init__.py

@@ -2,9 +2,10 @@
 # extreqs package
 """
 
-from .main import parse_requirement_files, parse_requirement_files_dict
 from importlib.metadata import version as _version
 
+from .main import parse_requirement_files, parse_requirement_files_dict
+
 __version__ = _version("extreqs")
 
 __all__ = ["parse_requirement_files", "parse_requirement_files_dict"]

{extreqs-1.2.0 → extreqs-1.3.0}/src/extreqs/main.py

@@ -1,5 +1,4 @@
 import logging
-import sys
 import typing as tp
 from collections import defaultdict
 from pathlib import Path
@@ -9,7 +8,7 @@ from requirements.requirement import Requirement
 logger = logging.getLogger(__name__)
 
 
-def str_as_list(s: tp.Optional[tp.Union[str, tp.List[str]]]) -> tp.List[str]:
+def str_as_list(s: str | list[str] | None) -> list[str]:
     if s is None:
         return []
     if isinstance(s, str):
@@ -23,7 +22,7 @@ UNSUPPORTED_VCS = {"git", "hg", "svn", "bzr"}
 class Parser:
     def __init__(self, fpath, file_context=None) -> None:
         self.file_context = str_as_list(file_context)
-        self.block_context: tp.List[str] = []
+        self.block_context: list[str] = []
         self.fpath = fpath
         self.line_num = -1
 
@@ -117,7 +116,7 @@ def merge_install_extras(*install_extras):
 def parse_requirement_files(
     *req_files: Path,
     **extra_req_files: Path,
-) -> tp.Tuple[tp.List[str], tp.Dict[str, tp.List[str]]]:
+) -> tuple[list[str], dict[str, list[str]]]:
     """Parse requirements files into setuptools requirements.
 
     Requirements files whose listed dependencies all belong to
@@ -144,13 +143,9 @@ def parse_requirement_files(
     return (d["install_requires"], d["extras_require"])
 
 
-if sys.version_info < (3, 8):
-    ParsedFiles = dict
-else:
-
-    class ParsedFiles(tp.TypedDict):
-        install_requires: tp.List[str]
-        extras_require: tp.Dict[str, tp.List[str]]
+class ParsedFiles(tp.TypedDict):
+    install_requires: list[str]
+    extras_require: dict[str, list[str]]
 
 
 def parse_requirement_files_dict(

extreqs-1.2.0/PKG-INFO

@@ -1,14 +0,0 @@
-Metadata-Version: 2.3
-Name: extreqs
-Version: 1.2.0
-Summary: Parse python requirements.txt files into setuptools extras
-Classifier: Development Status :: 3 - Alpha
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Requires-Dist: requirements-parser>=0.13.0
-Requires-Python: >=3.10, <4.0