DEP: Remove Scripts, Resources, Tests, Sample_Code (py-pdf#845)

* All of them are removed from the package distributions
* Scripts is additionally moved to the cpdf project
* Sample_Code is moved to the docs

Author: MartinThoma

.github/workflows/benchmark.yaml

@@ -30,7 +30,7 @@ jobs:
         pip install .
     - name: Run benchmark
       run: |
-        pytest Tests/bench.py --benchmark-json output.json
+        pytest tests/bench.py --benchmark-json output.json
     - name: Store benchmark result
       uses: benchmark-action/github-action-benchmark@v1
       with:

.github/workflows/github-ci.yaml

@@ -46,11 +46,11 @@ jobs:
         flake8 . --ignore=E203,W503,W504,E,F403,F405 --exclude build,sample-files
     - name: Test with pytest
       run: |
-        python -m coverage run --parallel-mode -m pytest Tests -vv
+        python -m coverage run --parallel-mode -m pytest tests -vv
       if: matrix.python-version != '3.10.1'
     - name: Test with pytest (OO flag)
       run: |
-        python -OO -m coverage run --parallel-mode -m pytest Tests -vv
+        python -OO -m coverage run --parallel-mode -m pytest tests -vv
       if: matrix.python-version == '3.10.1'
     - name: Upload coverage data
       uses: actions/upload-artifact@v3

CHANGELOG

@@ -21,6 +21,11 @@ Deprecations (DEP):
 - `PyPDF2.pdf` (the `pdf` module) no longer exists. The contents were moved with
   the library. You should most likely import directly from `PyPDF2` instead.
   The `RectangleObject` is in `PyPDF2.generic`.
+- The `Resources`, `Scripts`, and `Tests` will no longer be part of the distribution
+  files on PyPI. This should have little to no impact on most people. The
+  `Tests` are renamed to `tests`, the `Resources` are renamed to `resources`.
+  Both are still in the git repository. The `Scripts` are now in
+  https://github.com/py-pdf/cpdf. `Sample_Code` was moved to the `docs`.
 
 Version 1.27.12, 2022-05-02
 ---------------------------

MANIFEST.in

@@ -1,5 +1,2 @@
 include CHANGELOG
 include LICENSE
-recursive-include Resources *
-recursive-include Scripts *
-recursive-include Tests *

Makefile

@@ -14,10 +14,10 @@ upload:
 clean:
 	python setup.py clean --all
 	pyclean .
-	rm -rf Tests/__pycache__ PyPDF2/__pycache__ Image9.png htmlcov docs/_build dist dont_commit_merged.pdf dont_commit_writer.pdf PyPDF2.egg-info PyPDF2_pdfLocation.txt .pytest_cache .mypy_cache .benchmarks
+	rm -rf tests/__pycache__ PyPDF2/__pycache__ Image9.png htmlcov docs/_build dist dont_commit_merged.pdf dont_commit_writer.pdf PyPDF2.egg-info PyPDF2_pdfLocation.txt .pytest_cache .mypy_cache .benchmarks
 
 test:
-	pytest Tests --cov --cov-report term-missing -vv --cov-report html --durations=3 --timeout=30
+	pytest tests --cov --cov-report term-missing -vv --cov-report html --durations=3 --timeout=30
 
 mutation-test:
 	mutmut run
@@ -27,4 +27,4 @@ mutmut-results:
 	junit2html mutmut-results.xml mutmut-results.html
 
 benchmark:
-	pytest Tests/bench.py
+	pytest tests/bench.py

README.md

@@ -6,7 +6,7 @@
 
 TESTS_ROOT = os.path.abspath(os.path.dirname(__file__))
 PROJECT_ROOT = os.path.dirname(TESTS_ROOT)
-RESOURCE_ROOT = os.path.join(PROJECT_ROOT, "Resources")
+RESOURCE_ROOT = os.path.join(PROJECT_ROOT, "resources")
 
 
 def page_ops(pdf_path, password):

Sample_Code/hierarchical_toc.md

@@ -8,7 +8,7 @@
 
 TESTS_ROOT = os.path.abspath(os.path.dirname(__file__))
 PROJECT_ROOT = os.path.dirname(TESTS_ROOT)
-RESOURCE_ROOT = os.path.join(PROJECT_ROOT, "Resources")
+RESOURCE_ROOT = os.path.join(PROJECT_ROOT, "resources")
 
 
 def test_basic_features():

Scripts/2-up.py

@@ -7,7 +7,7 @@
 # Configure path environment
 TESTS_ROOT = os.path.abspath(os.path.dirname(__file__))
 PROJECT_ROOT = os.path.dirname(TESTS_ROOT)
-RESOURCE_ROOT = os.path.join(PROJECT_ROOT, "Resources")
+RESOURCE_ROOT = os.path.join(PROJECT_ROOT, "resources")
 
 
 @pytest.fixture()

Scripts/booklet.py

@@ -6,7 +6,7 @@
 
 TESTS_ROOT = os.path.abspath(os.path.dirname(__file__))
 PROJECT_ROOT = os.path.dirname(TESTS_ROOT)
-RESOURCE_ROOT = os.path.join(PROJECT_ROOT, "Resources")
+RESOURCE_ROOT = os.path.join(PROJECT_ROOT, "resources")
 
 sys.path.append(PROJECT_ROOT)
 

Scripts/pdf-image-extractor.py

@@ -8,7 +8,7 @@
 
 TESTS_ROOT = os.path.abspath(os.path.dirname(__file__))
 PROJECT_ROOT = os.path.dirname(TESTS_ROOT)
-RESOURCE_ROOT = os.path.join(PROJECT_ROOT, "Resources")
+RESOURCE_ROOT = os.path.join(PROJECT_ROOT, "resources")
 EXTERNAL_ROOT = os.path.join(PROJECT_ROOT, "sample-files")