Single-sourcing package version for setup.cfg Python projects

Single-sourcing package version for setup.cfg Python projects

Single-sourcing the package version in setup.cfg for Python projects is a good practice to ensure consistency and avoid duplication of version information across different files. One common approach is to define the package version in a separate module or file and then import that version into setup.cfg.

Here's how you can achieve single-sourcing of the package version:

  • Create a separate Python file (e.g., version.py) in the root of your project. In this file, define a variable to hold the package version. For example:
# version.py __version__ = '1.0.0'
  • In your setup.cfg file, use the importlib_metadata option to import the version from the version.py file:
# setup.cfg [metadata] name = your_package_name version = attr: your_package_name.version.__version__
  • To ensure that the version.py file is always available when installing or distributing the package, make sure to include it in your package's source distribution. You can use the include_package_data option in setup.cfg:
# setup.cfg [options] package_dir = = src packages = find: [options.package_data] your_package_name = version.py
  • Place your package code inside a src directory (or any other directory you specified in package_dir above) to keep the package structure clean and organized.

By following these steps, you have successfully single-sourced the package version in your setup.cfg file. Now, the version is maintained in a single location (version.py) and automatically imported into setup.cfg when building, installing, or distributing your Python package. This approach reduces redundancy and makes it easier to manage the version across your project.

Examples

  1. "Single-sourcing package version setup.cfg example"

    • Description: This query seeks examples of how to single-source package versions using setup.cfg in Python projects.
    [metadata] version = attr: package.__version__

  2. "How to use setup.cfg for versioning in Python projects"

    • Description: This query looks for guidance on utilizing setup.cfg to manage versioning within Python projects.
    [metadata] version = attr: my_package.__version__

  3. "setup.cfg versioning best practices"

    • Description: Users searching this query aim to discover recommended practices for managing package versions via setup.cfg in Python projects.
    [metadata] version = attr: my_module.__version__

  4. "setup.cfg version field for Python projects"

    • Description: This query is about understanding how the version field is utilized in setup.cfg within Python projects.
    [metadata] version = attr: my_library.__version__

  5. "Python project versioning setup.cfg example"

    • Description: Users looking for this query want to see concrete examples of versioning setups using setup.cfg in Python projects.
    [metadata] version = attr: project.version

  6. "How to manage package versions in setup.cfg"

    • Description: This query aims to find information on managing package versions effectively using setup.cfg in Python projects.
    [metadata] version = attr: my_project.__version__

  7. "Single-source versioning in setup.cfg Python"

    • Description: This query refers to single-sourcing versioning information in setup.cfg specifically for Python projects.
    [metadata] version = attr: my_package.version

  8. "setup.cfg versioning vs. setup.py versioning"

    • Description: Users comparing versioning methods seek to understand the differences between using setup.cfg and setup.py for version management in Python projects.
    [metadata] version = attr: my_package_version.version

  9. "setup.cfg versioning for setuptools"

    • Description: This query focuses on how to configure versioning using setup.cfg with setuptools in Python projects.
    [metadata] version = attr: my_package.version_info

  10. "setup.cfg versioning tutorial Python"

    • Description: This query indicates users are looking for tutorials on implementing versioning via setup.cfg in Python projects.
    [metadata] version = attr: my_package.get_version()

More Tags

code-generation keytool msgpack nest crc stringbuilder data-pipeline ios8 photokit gis

More Python Questions

More Chemical thermodynamics Calculators

More Weather Calculators

More Statistics Calculators

More Electronics Circuits Calculators