Consolidate dependencies

- have all dependencies in pyproject.toml only
- remove requirements.txt files and tox.ini
- adapt contributing guide for documentation creation
- fix some dockerfile warnings

Author: mrbean-bremen

.github/workflows/dockerfiles/Dockerfile_debian

@@ -13,13 +13,12 @@
 # limitations under the License.
 
 FROM debian
-MAINTAINER jmcgeheeiv@users.noreply.github.com
 
 RUN apt-get update && apt-get install -y locales
 RUN locale-gen en_US.UTF-8
-ENV LANG en_US.UTF-8
-ENV LANGUAGE en_US:en
-ENV LC_ALL en_US.UTF-8
+ENV LANG=en_US.UTF-8
+ENV LANGUAGE=en_US:en
+ENV LC_ALL=en_US.UTF-8
 ARG github_repo=pytest-dev/pyfakefs
 ARG github_branch=main
 
@@ -40,12 +39,11 @@ RUN WORK_DIR=`ls -d work/*`; mv $WORK_DIR work/pyfakefs
 RUN chown -R pyfakefs:pyfakefs work/pyfakefs
 WORKDIR work/pyfakefs
 RUN python3 -m venv ../venv
-RUN ../venv/bin/pip install -r requirements.txt
-RUN ../venv/bin/pip install -r extra_requirements.txt
+RUN ../venv/bin/pip install --group dev --group extra
 RUN ../venv/bin/pip install parquet pyarrow
 RUN ../venv/bin/pip install -e .
 
 USER pyfakefs
-ENV PYTHONPATH work/pyfakefs
+ENV PYTHONPATH=work/pyfakefs
 ENV TEST_REAL_FS=1
 CMD ["../venv/bin/pytest", "pyfakefs/pytest_tests", "pyfakefs/tests"]

.github/workflows/dockerfiles/Dockerfile_fedora

@@ -13,11 +13,10 @@
 # limitations under the License.
 
 FROM fedora:latest
-MAINTAINER jmcgeheeiv@users.noreply.github.com
 
-ENV LANG en_US.UTF-8
-ENV LANGUAGE en_US:en
-ENV LC_ALL en_US.UTF-8
+ENV LANG=en_US.UTF-8
+ENV LANGUAGE=en_US:en
+ENV LC_ALL=en_US.UTF-8
 ARG github_repo=pytest-dev/pyfakefs
 ARG github_branch=main
 
@@ -31,11 +30,10 @@ RUN mkdir -p work \
 RUN WORK_DIR=`ls -d work/*`; mv $WORK_DIR work/pyfakefs
 RUN chown -R pyfakefs:pyfakefs work/pyfakefs
 WORKDIR work/pyfakefs
-RUN pip3 install -r requirements.txt
-RUN pip3 install -r extra_requirements.txt
+RUN pip3 install --group dev --group extra
 RUN pip3 install -e .
 
 USER pyfakefs
-ENV PYTHONPATH work/pyfakefs
+ENV PYTHONPATH=work/pyfakefs
 ENV TEST_REAL_FS=1
 CMD ["pytest", "pyfakefs/pytest_tests", "pyfakefs/tests"]

.github/workflows/dockerfiles/Dockerfile_redhat

@@ -13,7 +13,6 @@
 # limitations under the License.
 
 FROM registry.access.redhat.com/ubi9/ubi
-LABEL maintainer="John McGehee"
 
 ARG github_repo=pytest-dev/pyfakefs
 ARG github_branch=main
@@ -22,9 +21,9 @@ RUN yum update --disablerepo=* --enablerepo=ubi-9-appstream-rpms --enablerepo=ub
 RUN yum install -y python3.12 python3.12-pip unzip wget
 RUN python3.12 --version
 
-ENV LANG en_US.UTF-8
-ENV LANGUAGE en_US:en
-ENV LC_COLLATE C.UTF-8
+ENV LANG=en_US.UTF-8
+ENV LANGUAGE=en_US:en
+ENV LC_COLLATE=C.UTF-8
 
 RUN useradd pyfakefs
 
@@ -34,11 +33,11 @@ RUN mkdir -p work \
 RUN WORK_DIR=`ls -d work/*`; mv $WORK_DIR work/pyfakefs
 RUN chown -R pyfakefs:pyfakefs work/pyfakefs
 WORKDIR work/pyfakefs
-RUN pip3.12 install -r requirements.txt
-RUN pip3.12 install -r extra_requirements.txt
+RUN python3.12 -m pip install --upgrade pip
+RUN pip3.12 install --group dev --group extra
 RUN pip3.12 install -e .
 
 USER pyfakefs
-ENV PYTHONPATH work/pyfakefs
+ENV PYTHONPATH=work/pyfakefs
 ENV TEST_REAL_FS=1
 CMD ["python3.12", "-m", "pytest", "pyfakefs/pytest_tests", "pyfakefs/tests"]

.github/workflows/dockerfiles/Dockerfile_ubuntu

@@ -13,13 +13,12 @@
 # limitations under the License.
 
 FROM ubuntu
-MAINTAINER jmcgeheeiv@users.noreply.github.com
 
 RUN apt-get update && apt-get install -y locales
 RUN locale-gen en_US.UTF-8
-ENV LANG en_US.UTF-8
-ENV LANGUAGE en_US:en
-ENV LC_ALL en_US.UTF-8
+ENV LANG=en_US.UTF-8
+ENV LANGUAGE=en_US:en
+ENV LC_ALL=en_US.UTF-8
 ARG github_repo=pytest-dev/pyfakefs
 ARG github_branch=main
 
@@ -40,12 +39,12 @@ RUN WORK_DIR=`ls -d work/*`; mv $WORK_DIR work/pyfakefs
 RUN chown -R pyfakefs:pyfakefs work/pyfakefs
 WORKDIR work/pyfakefs
 RUN python3 -m venv ../venv
-RUN ../venv/bin/pip install -r requirements.txt
-RUN ../venv/bin/pip install -r extra_requirements.txt
+RUN ../venv/bin/python3 -m pip install --upgrade pip
+RUN ../venv/bin/pip install --group dev --group extra
 RUN ../venv/bin/pip install parquet pyarrow
 RUN ../venv/bin/pip install -e .
 
 USER pyfakefs
-ENV PYTHONPATH work/pyfakefs
+ENV PYTHONPATH=work/pyfakefs
 ENV TEST_REAL_FS=1
 CMD ["../venv/bin/pytest", "pyfakefs/pytest_tests", "pyfakefs/tests"]

.github/workflows/release-deploy.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: [ '3.10' ]
+        python-version: [ '3.13' ]
 
     steps:
     - uses: actions/checkout@v6

.github/workflows/testsuite.yml

@@ -54,14 +54,14 @@ jobs:
       uses: actions/cache@v5
       with:
         path: ${{ steps.pip-cache.outputs.dir }}
-        key: ${{ matrix.os }}-${{ matrix.python-version }}-pip-${{ hashFiles('**/requirements.txt') }}-${{ hashFiles('**/extra_requirements.txt') }}
+        key: ${{ matrix.os }}-${{ matrix.python-version }}-pip-${{ hashFiles('**/pyproject.toml') }}
         restore-keys: |
           ${{ matrix.os }}-${{ matrix.python-version }}-pip-
 
     - name: Install dependencies
       run: |
         pip install setuptools wheel
-        pip install -r requirements.txt
+        pip install --group dev
     - name: Run unit tests without extra packages as non-root user
       run: |
         export TEST_REAL_FS=1
@@ -77,7 +77,7 @@ jobs:
     - name: Install extra dependencies
       if: matrix.os != 'windows-latest' || matrix.python-version != 'pypy-3.11'
       run: |
-        pip install -r extra_requirements.txt
+        pip install --group extra
         pip install zstandard cffi  # needed to test #910
       shell: bash
     - name: Run unit tests with extra packages as non-root user
@@ -123,7 +123,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install -r requirements.txt
+          python -m pip install --group dev
           python -m pip install -U pytest==${{ matrix.pytest-version }}
           python -m pip install pandas parquet pyarrow
           python -m pip install -e .
@@ -150,8 +150,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          pip install -r requirements.txt
-          pip install -r extra_requirements.txt
+          pip install .[dev,extra]
           pip install pytest-find-dependencies
       - name: Check dependencies
         run: python -m pytest --find-dependencies pyfakefs/tests

.readthedocs.yaml

@@ -14,4 +14,7 @@ sphinx:
 
 python:
   install:
-    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc

CHANGES.md

@@ -9,6 +9,7 @@ The released versions correspond to PyPI releases.
 
 ### Infrastructure
 * added PyPy 3.11 to CI, added PyPy builds for all OSes
+* use only `pyproject.toml` for dependencies, moved `tox` configuration into `pyproject.toml`
 
 ### Fixes
 * fixed a problem with `readable` raising an error on a file object.

CONTRIBUTING.md

@@ -1,15 +1,15 @@
 
 # Contributing to pyfakefs
 
-We welcome any contributions that help to improve pyfakefs for the community.
+We welcome any contributions that help to improve `pyfakefs` for the community.
 Contributions may include bug reports, bug fixes, new features, infrastructure enhancements, or
 documentation updates.
 
 ## How to contribute
 
 ### Reporting Bugs
 
-If you think you found a bug in pyfakefs, you can [create an issue](https://help.github.com/articles/creating-an-issue/).
+If you think you found a bug in `pyfakefs`, you can [create an issue](https://help.github.com/articles/creating-an-issue/).
 Before filing the bug, please check, if it still exists in the [main branch](https://github.com/pytest-dev/pyfakefs).
 If you can reproduce the problem, please provide enough information so that it can be reproduced by other developers.
 This includes:
@@ -21,9 +21,9 @@ For better readability, you may use [markdown code formatting](https://help.gith
 
 ### Proposing Enhancements
 
-If you need a specific feature that is not implemented, or have an idea for the next
-exciting gimmick in pyfakefs, you can also create a respective issue.
-Of course - implementing it yourself is the best chance to get it done!
+If you need a specific feature that is not implemented, or have an idea for a useful addition,
+you may also create a respective issue.
+As usually, implementing it yourself is the best chance to get it done!
 The next item has some information on doing this.
 
 ### Contributing Code
@@ -34,25 +34,33 @@ develop on a feature branch, and [create a pull request](https://help.github.com
 There are a few things to consider for contributing code:
   * We ensure the [PEP-8 coding style](https://www.python.org/dev/peps/pep-0008/)
     by using [black](https://pypi.org/project/black/) auto-format in a
-    pre-commit hook; you can locally install
-    [pre-commit](https://pypi.org/project/pre-commit/) to run the linter
-    tests on check-in or on demand (`pre-commit run --all-files`)
-  * Use the [Google documentation style](https://google.github.io/styleguide/pyguide.html) to document new public classes or methods
-  * Provide unit tests for bug fixes or new functionality - check the existing tests for examples
-  * Provide meaningful commit messages - it is ok to amend the commits to improve the comments
-  * Check that the automatic GitHub Action CI tests all pass for your pull request
-  * Be ready to adapt your changes after a code review
+    pre-commit hook. We recommend to locally install
+    [pre-commit](https://pypi.org/project/pre-commit/) (`pre-commit install`) to run the linter
+    tests on check-in, or run the tests on demand (`pre-commit run --all-files`).
+  * Use the [Google documentation style](https://google.github.io/styleguide/pyguide.html) to document new public classes or methods.
+  * Provide unit tests for bug fixes or new functionality - check the existing tests for examples.
+  * Provide meaningful commit messages - it is ok to amend the commits to improve the comments.
+  * Check that the automatic GitHub Action CI tests all pass for your pull request.
+  * Be ready to adapt your changes after a code review.
 
 ### Contributing Documentation
 
 If you want to improve the existing documentation, you can do this also using a pull request.
 You can contribute to:
   * the source code documentation using [Google documentation style](https://google.github.io/styleguide/pyguide.html)
   * the [README](https://github.com/pytest-dev/pyfakefs/blob/main/README.md) using [markdown syntax](https://help.github.com/articles/basic-writing-and-formatting-syntax/)
-  * the documentation published on [Read the Docs](https://pytest-pyfakefs.readthedocs.io/en/latest/),
-    located in the `docs` directory (call `make html` from that directory).
-    For building the documentation, you will need [sphinx](http://sphinx.pocoo.org/).
-  * [this file](https://github.com/pytest-dev/pyfakefs/blob/main/CONTRIBUTING.md)
-  if you want to enhance the contributing guide itself
+  * the documentation published on [Read the Docs](https://pytest-pyfakefs.readthedocs.io/en/latest/) and located in the `docs` directory,
+    using [reStructuredText syntax](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html)
 
-Thanks for taking the time to contribute to pyfakefs!
+To build the documentation locally, you need to install the needed dependencies by calling
+```
+python -m pip install .[doc]
+```
+from your source directory. Then you can create the documentation:
+```
+cd docs
+make html
+```
+The generated documentation will be located under *docs/html*.
+
+Thank you for taking the time to contribute to pyfakefs!

Dockerfile

@@ -23,15 +23,14 @@
 #     docker run   -t pyfakefs
 
 FROM ubuntu
-MAINTAINER jmcgeheeiv@users.noreply.github.com
 
 # The Ubuntu base container does not specify a locale.
 # pyfakefs tests require at least the Latin1 character set.
 RUN apt-get update && apt-get install -y locales
 RUN locale-gen en_US.UTF-8
-ENV LANG en_US.UTF-8
-ENV LANGUAGE en_US:en
-ENV LC_ALL en_US.UTF-8
+ENV LANG=en_US.UTF-8
+ENV LANGUAGE=en_US:en
+ENV LC_ALL=en_US.UTF-8
 
 RUN apt-get update && apt-get install -y \
     python3-pip \
@@ -45,9 +44,8 @@ RUN wget https://github.com/pytest-dev/pyfakefs/archive/main.zip \
     && unzip main.zip \
     && chown -R pyfakefs:pyfakefs /pyfakefs-main
 WORKDIR /pyfakefs-main
-RUN pip3 install -r requirements.txt
-RUN pip3 install -r extra_requirements.txt
+RUN pip3 install --group dev --group extra
 
 USER pyfakefs
-ENV PYTHONPATH /pyfakefs-main
+ENV PYTHONPATH=/pyfakefs-main
 CMD ["python3", "-m", "pyfakefs.tests.all_tests"]