Package: tinypkg
📦 py-tiny-pkga tiny packaging example that only has apyproject.tomlw/setuptools 🔨🎉 setuptoolsv61.0.0is released with experimental support forpyproject.tomlseehttps://discuss.python.org/t/help-testing-experimental-features-in-setuptools/🦾 motivationwe can find lots of packaging examples withpoetry,pdm, etc., but hard to find examples with the standardsetuptoolsbased on the latest PEP supports.✔️ confirmed versionsUbuntu 20.04Mac OS X 11.6.4python 3.7.*, 3.8.*, 3.9.*pip 22.0.4+⬇️ install locallyclone this repo$ pip install .or$ pip install .[dev](for testing)$ pip show tinypkgName: tinypkg
Version: 0.0.0
Summary: a tiny package example w/setuptools
Home-page: github.com/denkiwakame/tiny-pkg
Author: denkiwakame
Author-email: denkivvakame@gmail.com
License: MIT License
        Copyright (c) 2022 denkiwakame
        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.
Location: ...
Requires: requests👩‍🔧 testing$ pip install .[dev]$ python -m pytest --cov:octocat: install from GitHub.compip install git+https://github.com/denkiwakame/py-tiny-pkg📝 editable install (-e)ERROR: Project file:///../tiny-py-pkg has a 'pyproject.toml' and its build backend is missing the 'build_editable' hook. Since it does not have a 'setup.py' nor a 'setup.cfg', it cannot be installed in editable mode. Consider using a build backend that supports PEP 660.workaround:locatesetup.pythat contains the following lines:and then$ pip install -e .fromsetuptoolsimportsetupsetup()in near future, editable install will work on projets that only have apyproject.toml📑 PEP660https://peps.python.org/pep-0660/pip 21.1+ supportsbuild_editablehookhttps://pip.pypa.io/en/stable/reference/build-system/pyproject-toml/#editable-installationsetuptools support (wip)https://github.com/pypa/setuptools/issues/2816❓ How can I manage ext_modules ?pyproject.tomldoes not strictly intend to replacesetup.py.If you need to build C/C++ extension modules w/pybind11or something, write the followingsetup.py(dynamic config) alongside with thepyproject.toml(metadata file).importsubprocessimportosimportsysfromsetuptoolsimportExtension,setupfromsetuptools.command.build_extimportbuild_extclassCMakeExtension(Extension):def__init__(self,name,sourcedir=""):Extension.__init__(self,name,sources=[])self.sourcedir=os.path.abspath(sourcedir)classCMakeBuild(build_ext):defbuild_extension(self,ext):cfg="Debug"ifself.debugelse"Release"# TODOextdir=os.path.abspath(os.path.dirname(self.get_ext_fullpath(ext.name)))cmake_args=[f"-DCMAKE_LIBRARY_OUTPUT_DIRECTORY={extdir}",f"-DPYTHON_EXECUTABLE={sys.executable}",f"-DCMAKE_BUILD_TYPE={cfg}",]build_args=[]ifnotos.path.exists(self.build_temp):os.makedirs(self.build_temp)subprocess.check_call(["cmake",ext.sourcedir]+cmake_args,cwd=self.build_temp)subprocess.check_call(["cmake","--build","."]+build_args,cwd=self.build_temp)setup(ext_modules=[CMakeExtension("bindings")],cmdclass={"build_ext":CMakeBuild},)📦 publish to PyPIusepypa/build, a simple PEP 517 frontend andpypa/gh-action-pypi-publishhttps://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/📚 Referncespyproject.tomlhttps://pip.pypa.io/en/stable/reference/build-system/pyproject-toml/build-system📑 PEP 517https://www.python.org/dev/peps/pep-0517/setuptools supporthttps://setuptools.pypa.io/en/latest/build_meta.html📑 PEP 518https://www.python.org/dev/peps/pep-0518/metadata📑 PEP 621https://peps.python.org/pep-0621/setuptools support (wip)https://github.com/pypa/setuptools/issues/1688experimental releasehttps://discuss.python.org/t/help-testing-experimental-features-in-setuptools/13821linter support for pyproject.tomlblack (supported)isort (supported)mypy (supported)https://github.com/python/mypy/issues/5205flake8https://github.com/PyCQA/flake8/issues/234pyproject-flake8https://github.com/csachs/pyproject-flake8