extreqs 1.1.0__tar.gz → 1.2.1__tar.gz

extreqs-1.2.1/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: extreqs
+Version: 1.2.1
+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.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
+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.2.1/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.2.1/pyproject.toml

@@ -0,0 +1,34 @@
+[project]
+name = "extreqs"
+version = "1.2.1"
+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",
+]
+
+dependencies = [
+    "requirements-parser>=0.13.0",
+]
+
+[build-system]
+requires = ["uv_build>=0.10.0,<0.11.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "mypy>=1.19.1",
+    "pdoc3>=0.11.6",
+    "pytest>=9.0.2",
+    "ruff>=0.15.0",
+]

{extreqs-1.1.0 → extreqs-1.2.1/src}/extreqs/__init__.py

@@ -1,8 +1,10 @@
 """
 # extreqs package
 """
+
 from .main import parse_requirement_files, parse_requirement_files_dict
-from .version import version as __version__  # noqa: F401
-from .version import version_tuple as __version_info__  # noqa: F401
+from importlib.metadata import version as _version
+
+__version__ = _version("extreqs")
 
 __all__ = ["parse_requirement_files", "parse_requirement_files_dict"]

{extreqs-1.1.0 → extreqs-1.2.1/src}/extreqs/main.py

@@ -4,7 +4,7 @@ import typing as tp
 from collections import defaultdict
 from pathlib import Path
 
-import pkg_resources
+from requirements.requirement import Requirement
 
 logger = logging.getLogger(__name__)
 
@@ -17,6 +17,9 @@ def str_as_list(s: tp.Optional[tp.Union[str, tp.List[str]]]) -> tp.List[str]:
     return s
 
 
+UNSUPPORTED_VCS = {"git", "hg", "svn", "bzr"}
+
+
 class Parser:
     def __init__(self, fpath, file_context=None) -> None:
         self.file_context = str_as_list(file_context)
@@ -45,6 +48,15 @@ class Parser:
         if req.startswith("#"):
             return None
 
+        components = req.split("+", maxsplit=1)
+        if len(components) == 2:
+            vcs = components[0]
+            if vcs in UNSUPPORTED_VCS:
+                raise RuntimeError(
+                    f"Invalid VCS dependency `{req}`. Use this format instead: "
+                    "`{package_name} @ {vcs}+{url}`"
+                )
+
         if len(extra_specs) > 1:
             logger.warning(
                 "Multiple extra specs found; ignoring all but the first %s:%s",
@@ -76,11 +88,12 @@ class Parser:
 
                 req, context = result
 
-                if not is_valid_req(req):
+                try:
+                    Requirement.parse(req)
+                except ValueError as e:
                     raise ValueError(
-                        f"'{req}' is not a valid requirement string "
-                        f"{self.fpath}:{self.line_num}"
-                    )
+                        f"'{req}' ({self.fpath}:{self.line_num}) is not a valid requirement string: {e}"
+                    ) from e
 
                 if not context:
                     install_requires.append(req)
@@ -127,11 +140,8 @@ def parse_requirement_files(
         `install_requires` and `extras_require` arguments
         respectively.
     """
-    to_merge = [Parser(fpath).parse() for fpath in req_files]
-    to_merge.extend(
-        Parser(fpath, extra).parse() for extra, fpath in extra_req_files.items()
-    )
-    return merge_install_extras(*to_merge)
+    d = parse_requirement_files_dict(*req_files, **extra_req_files)
+    return (d["install_requires"], d["extras_require"])
 
 
 if sys.version_info < (3, 8):
@@ -171,17 +181,20 @@ def parse_requirement_files_dict(
             "extras_require": {"extra_name": ["some", "requirement]},
         }
     """
-    install_requires, extras_require = parse_requirement_files(
-        *req_files, **extra_req_files
+    to_merge = [Parser(fpath).parse() for fpath in req_files]
+    to_merge.extend(
+        Parser(fpath, extra).parse() for extra, fpath in extra_req_files.items()
+    )
+    install_requires, extras_require = merge_install_extras(*to_merge)
+    return ParsedFiles(
+        install_requires=install_requires,
+        extras_require=extras_require,
     )
-    return ParsedFiles(install_requires=install_requires, extras_require=extras_require)
 
 
-def is_valid_req(req):
+def is_valid_req(req: str):
     try:
-        reqs = list(pkg_resources.parse_requirements(req))
-        if len(reqs) != 1:
-            return False
-    except Exception:
+        Requirement.parse(req)
+        return True
+    except ValueError:
         return False
-    return True

extreqs-1.1.0/.editorconfig

@@ -1,16 +0,0 @@
-[*]
-indent_style = space
-indent_size = 4
-insert_final_newline = true
-trim_trailing_whitespace = true
-end_of_line = lf
-charset = utf-8
-
-[*.py]
-max_line_length = 88
-
-[Makefile]
-indent_style = tab
-
-[*.{yaml,json}]
-indent_size = 2

extreqs-1.1.0/.flake8

@@ -1,5 +0,0 @@
-[flake8]
-max-line-length = 88
-extend-ignore = E203
-
-exclude = env

extreqs-1.1.0/.github/workflows/ci.yaml

@@ -1,55 +0,0 @@
-on: [push, pull_request]
-name: Lint, test, deploy package
-
-defaults:
-  run:
-    shell: bash
-
-jobs:
-
-  lint:
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
-        with:
-          python-version: '3.x'
-      - run: pip install $(grep -E '^(black|flake8|isort|mypy)' requirements.txt)
-      - run: make lint
-
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-      - run: |
-          pip install -U pip wheel setuptools
-          pip install -r requirements.txt
-        name: Install dependencies
-      - run: |
-          pip install .
-        name: Install package
-      - run: pytest --verbose
-
-  deploy-package:
-    runs-on: ubuntu-20.04
-    needs: [lint, test]
-    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
-        with:
-          python-version: 3.9
-      - run: pip install build
-      - run: python -m build --sdist --wheel -o dist/ .
-      - name: Publish package
-        uses: pypa/gh-action-pypi-publish@master
-        with:
-          user: __token__
-          password: ${{ secrets.pypi_password }}

extreqs-1.1.0/.gitignore

@@ -1,143 +0,0 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-cover/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-extreqs/version.py
-
-docs/
-env/

extreqs-1.1.0/Makefile

@@ -1,35 +0,0 @@
-.PHONY: fmt
-fmt:
-	isort . \
-	&& black .
-
-.PHONY: lint
-lint:
-	black --check .
-	isort --check .
-	flake8 .
-
-lint-type: lint
-	mypy .
-
-.PHONY: test
-test:
-	pytest --verbose
-
-.PHONY: install
-install:
-	pip install .
-
-.PHONY: install-dev
-install-dev:
-	pip install -r requirements.txt \
-	&& pip install -e .
-
-.PHONY: clean-docs
-clean-docs:
-	rm -rf docs
-
-.PHONY: docs
-docs: clean-docs
-	mkdir -p docs \
-	&& pdoc --html --output-dir docs extreqs

extreqs-1.1.0/PKG-INFO

@@ -1,109 +0,0 @@
-Metadata-Version: 2.1
-Name: extreqs
-Version: 1.1.0
-Summary: Parse python requirements.txt files into setuptools extras
-Home-page: https://github.com/clbarnes/extreqs
-Author: Chris L. Barnes
-Classifier: Development Status :: 3 - Alpha
-Classifier: License :: OSI Approved :: MIT License
-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
-Requires-Python: >=3.7, <4.0
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# extreqs
-
-Parse python requirements.txt files into setuptools extras.
-
-## 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: extra1
-
-#extra: extra2
-dep3
-
-#extra: extra3  # you can still have freeform comments!
-dep4  #extra: extra4 extra5
-dep5
-```
-
-would be parsed into
-
-```python
-install_requires = ["dep1"]
-extras_require = {
-    "extra1": ["dep2"],
-    "extra2": ["dep3"],
-    "extra3": ["dep4", "dep5"],
-    "extra4": ["dep4"],
-    "extra5": ["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`).
-
-## Notes
-
-This package should only be used in certain circumstances, and may lead to bad habits if over-used.
-Requirements files are intended for specifying reproducible (i.e. hard version constraints), maximal environments for other developers, CI, and so on to be able to run all tests, features, lints etc..
-Package dependencies are intended to specify the minimal dependencies with permissive version constraints for users to install the package for use.
-
-This package is, therefore, more applicable to distributing applications (CLI, web backends, etc.) than it is libraries.

extreqs-1.1.0/README.md

@@ -1,92 +0,0 @@
-# extreqs
-
-Parse python requirements.txt files into setuptools extras.
-
-## 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: extra1
-
-#extra: extra2
-dep3
-
-#extra: extra3  # you can still have freeform comments!
-dep4  #extra: extra4 extra5
-dep5
-```
-
-would be parsed into
-
-```python
-install_requires = ["dep1"]
-extras_require = {
-    "extra1": ["dep2"],
-    "extra2": ["dep3"],
-    "extra3": ["dep4", "dep5"],
-    "extra4": ["dep4"],
-    "extra5": ["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`).
-
-## Notes
-
-This package should only be used in certain circumstances, and may lead to bad habits if over-used.
-Requirements files are intended for specifying reproducible (i.e. hard version constraints), maximal environments for other developers, CI, and so on to be able to run all tests, features, lints etc..
-Package dependencies are intended to specify the minimal dependencies with permissive version constraints for users to install the package for use.
-
-This package is, therefore, more applicable to distributing applications (CLI, web backends, etc.) than it is libraries.

extreqs-1.1.0/extreqs/version.py

@@ -1,4 +0,0 @@
-# file generated by setuptools_scm
-# don't change, don't track in version control
-__version__ = version = '1.1.0'
-__version_tuple__ = version_tuple = (1, 1, 0)

extreqs-1.1.0/extreqs.egg-info/PKG-INFO

@@ -1,109 +0,0 @@
-Metadata-Version: 2.1
-Name: extreqs
-Version: 1.1.0
-Summary: Parse python requirements.txt files into setuptools extras
-Home-page: https://github.com/clbarnes/extreqs
-Author: Chris L. Barnes
-Classifier: Development Status :: 3 - Alpha
-Classifier: License :: OSI Approved :: MIT License
-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
-Requires-Python: >=3.7, <4.0
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# extreqs
-
-Parse python requirements.txt files into setuptools extras.
-
-## 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: extra1
-
-#extra: extra2
-dep3
-
-#extra: extra3  # you can still have freeform comments!
-dep4  #extra: extra4 extra5
-dep5
-```
-
-would be parsed into
-
-```python
-install_requires = ["dep1"]
-extras_require = {
-    "extra1": ["dep2"],
-    "extra2": ["dep3"],
-    "extra3": ["dep4", "dep5"],
-    "extra4": ["dep4"],
-    "extra5": ["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`).
-
-## Notes
-
-This package should only be used in certain circumstances, and may lead to bad habits if over-used.
-Requirements files are intended for specifying reproducible (i.e. hard version constraints), maximal environments for other developers, CI, and so on to be able to run all tests, features, lints etc..
-Package dependencies are intended to specify the minimal dependencies with permissive version constraints for users to install the package for use.
-
-This package is, therefore, more applicable to distributing applications (CLI, web backends, etc.) than it is libraries.

extreqs-1.1.0/extreqs.egg-info/SOURCES.txt

@@ -1,23 +0,0 @@
-.editorconfig
-.flake8
-.gitignore
-LICENSE
-Makefile
-README.md
-mypy.ini
-pyproject.toml
-requirements.txt
-setup.py
-.github/workflows/ci.yaml
-extreqs/__init__.py
-extreqs/main.py
-extreqs/version.py
-extreqs.egg-info/PKG-INFO
-extreqs.egg-info/SOURCES.txt
-extreqs.egg-info/dependency_links.txt
-extreqs.egg-info/requires.txt
-extreqs.egg-info/top_level.txt
-tests/__init__.py
-tests/conftest.py
-tests/test_extreqs.py
-tests/fixtures/requirements.txt

extreqs-1.1.0/extreqs.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

extreqs-1.1.0/extreqs.egg-info/requires.txt

@@ -1 +0,0 @@
-setuptools

extreqs-1.1.0/extreqs.egg-info/top_level.txt

@@ -1 +0,0 @@
-extreqs

extreqs-1.1.0/mypy.ini

@@ -1,2 +0,0 @@
-[mypy]
-ignore_missing_imports = True

extreqs-1.1.0/pyproject.toml

@@ -1,10 +0,0 @@
-[build-system]
-requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.2"]
-build-backend = "setuptools.build_meta"
-
-[tool.setuptools_scm]
-write_to = "extreqs/version.py"
-
-[tool.isort]
-profile = "black"
-multi_line_output = 3

extreqs-1.1.0/requirements.txt

@@ -1,12 +0,0 @@
-# dev
-
-black
-flake8
-isort
-mypy
-pdoc3
-pytest
-setuptools
-setuptools-scm
-types-setuptools
-wheel

extreqs-1.1.0/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

extreqs-1.1.0/setup.py

@@ -1,29 +0,0 @@
-from pathlib import Path
-
-from setuptools import find_packages, setup
-
-with open(Path(__file__).resolve().parent / "README.md") as f:
-    readme = f.read()
-
-setup(
-    name="extreqs",
-    url="https://github.com/clbarnes/extreqs",
-    author="Chris L. Barnes",
-    description="Parse python requirements.txt files into setuptools extras",
-    long_description=readme,
-    long_description_content_type="text/markdown",
-    packages=find_packages(include=["extreqs"]),
-    install_requires=["setuptools"],
-    python_requires=">=3.7, <4.0",
-    classifiers=[
-        "Development Status :: 3 - Alpha",
-        "License :: OSI Approved :: MIT License",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-    ],
-    use_scm_version=True,
-    setup_requires=["setuptools_scm"],
-)

extreqs-1.1.0/tests/conftest.py

@@ -1,10 +0,0 @@
-from pathlib import Path
-
-import pytest
-
-here = Path(__file__).resolve().parent
-
-
-@pytest.fixture
-def fixture_dir():
-    return here / "fixtures"

extreqs-1.1.0/tests/fixtures/requirements.txt

@@ -1,9 +0,0 @@
-dep1
-dep2  #extra: extra1
-
-#extra: extra2
-dep3
-
-#extra: extra3  # you can still have freeform comments!
-dep4  #extra: extra4 extra5
-dep5

extreqs-1.1.0/tests/test_extreqs.py

@@ -1,43 +0,0 @@
-from extreqs import parse_requirement_files, parse_requirement_files_dict
-
-
-def test_importable():
-    import extreqs
-
-    assert extreqs.__version__
-
-
-def test_complex(fixture_dir):
-    fpath = fixture_dir / "requirements.txt"
-    install, extras = parse_requirement_files(fpath)
-
-    assert install == ["dep1"]
-    assert extras == {
-        "extra1": ["dep2"],
-        "extra2": ["dep3"],
-        "extra3": ["dep4", "dep5"],
-        "extra4": ["dep4"],
-        "extra5": ["dep4"],
-    }
-
-
-def test_file_context(fixture_dir):
-    fpath = fixture_dir / "requirements.txt"
-    install, extras = parse_requirement_files(optional=fpath)
-
-    assert install == []
-    assert extras["optional"] == ["dep1", "dep2", "dep3", "dep4", "dep5"]
-
-
-def test_as_dict(fixture_dir):
-    fpath = fixture_dir / "requirements.txt"
-    kwargs = parse_requirement_files_dict(fpath)
-    assert kwargs["install_requires"] == ["dep1"]
-    assert kwargs["extras_require"] == {
-        "extra1": ["dep2"],
-        "extra2": ["dep3"],
-        "extra3": ["dep4", "dep5"],
-        "extra4": ["dep4"],
-        "extra5": ["dep4"],
-    }
-    assert len(kwargs) == 2