From 611f5f2ad10071e808ce09a8d894f400fbcc8404 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Diemer?= Date: Fri, 7 Nov 2025 11:25:04 +0100 Subject: [PATCH] Replace setup.py with pyproject.toml | #41346 --- .github/workflows/python-ci.yml | 12 +-- .gitignore | 3 +- LICENSE | 165 ++++++++++++++++++++++++++++++++ MANIFEST.in | 3 - README.md | 6 +- pyproject.toml | 43 +++++++++ setup.py | 59 ------------ 7 files changed, 219 insertions(+), 72 deletions(-) create mode 100644 LICENSE delete mode 100644 MANIFEST.in create mode 100644 pyproject.toml delete mode 100644 setup.py diff --git a/.github/workflows/python-ci.yml b/.github/workflows/python-ci.yml index 2f1740a..2888873 100644 --- a/.github/workflows/python-ci.yml +++ b/.github/workflows/python-ci.yml @@ -16,12 +16,12 @@ jobs: strategy: fail-fast: false matrix: - python-version: [3.9, 3.11] + python-version: [3.11, 3.13] steps: - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - name: Install ffmpeg @@ -30,14 +30,14 @@ jobs: sudo apt-get install -y ffmpeg - name: Install Python dependencies run: | - python3 -m pip install --upgrade pip - python3 -m pip install flake8 vulture six + pip install --upgrade pip setuptools + pip install --no-cache-dir -e '.[dev]' - name: Lint code with Python ${{ matrix.python-version }} run: | flake8 . - name: Check for deadcode with Python ${{ matrix.python-version }} run: | - vulture --exclude docker/,submodules/ --min-confidence 90 . + vulture --min-confidence 90 converter - name: Run test with Python ${{ matrix.python-version }} run: | - python3 setup.py test + pytest --cov -- test/test.py diff --git a/.gitignore b/.gitignore index 51a31b6..49cf3dd 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,5 @@ /dist/ /doc/_build/ *.pyc - +__pycache__ +.coverage* diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index a45a114..0000000 --- a/MANIFEST.in +++ /dev/null @@ -1,3 +0,0 @@ -graft doc -prune doc/_build -include test/test1.ogg diff --git a/README.md b/README.md index c0c34be..8de9b44 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ There's a fair amount of documentation in `doc/` directory. To generate it from Sphinx sources, use: ``` sh -python setup.py doc +cd doc; make html; cd - ``` and then visit `doc/_build/html/index.html`. @@ -49,7 +49,7 @@ and then visit `doc/_build/html/index.html`. To run the automated tests: ``` sh -python setup.py test +pytest test/test.py ``` The test suite assumes you already have the required `ffmpeg` and `ffprobe` @@ -60,7 +60,7 @@ tools installed on your system. To install the package: ``` sh -python setup.py install +pip install . ``` Note that this only installs the Python Video Converter library. The `ffmpeg` diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..25d26f6 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,43 @@ +[build-system] +build-backend = "setuptools.build_meta" +requires = ["setuptools>=77.0"] + +[project] +name = "video-converter" +description = "Video Converter library." +version = "2.3.0" +authors = [{name = "UbiCast"}] +license = "LGPL-3.0" +license-files = ["LICENSE"] +readme = "README.md" +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Environment :: Other Environment", + "Intended Audience :: Developers", + "Operating System :: OS Independent", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Topic :: Utilities", +] +requires-python = ">=3.11" +dependencies = [ + "six", +] + +[project.optional-dependencies] +dev = [ + "flake8", + "pytest", + "pytest-cov", + "vulture", +] + +[project.urls] +Repository = "https://github.com/UbiCastTeam/python-video-converter" + +[tool.setuptools] +packages = ["converter", "converter.codecs"] +include-package-data = false + +[tool.coverage.run] +source_dirs = ["converter"] diff --git a/setup.py b/setup.py deleted file mode 100644 index 86df964..0000000 --- a/setup.py +++ /dev/null @@ -1,59 +0,0 @@ -#!/usr/bin/env python - -from distutils.core import setup, Command -import os - - -class TestCommand(Command): - user_options = [] - - def initialize_options(self): - self._testdir = os.path.join(os.getcwd(), 'test') - - def finalize_options(self): - pass - - def run(self): - os.chdir(self._testdir) - retval = os.system('python -m test') - if retval != 0: - raise Exception('tests failed') - - -class DocCommand(Command): - user_options = [] - - def initialize_options(self): - self._docdir = os.path.join(os.getcwd(), 'doc') - - def finalize_options(self): - pass - - def run(self): - os.chdir(self._docdir) - os.system('make html') - - -setup( - name='VideoConverter', - version='2.2.0', - description='Video Converter library', - url='https://github.com/senko/python-video-converter/', - - author='Senko Rasic', - author_email='senko.rasic@dobarkod.hr', - - cmdclass={ - 'test': TestCommand, - 'doc': DocCommand - }, - - packages=[ - 'converter', - 'converter.codecs', - ], - - install_requires=[ - 'six', - ], -)