bucket_26/python-setuptools-scm

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-setuptools-scm
   4 VERSION=                7.1.0
   5 KEYWORDS=               python
   6 VARIANTS=               py310 v11
   7 SDESC[py310]=           Package to manage versions by scm tags (3.10)
   8 SDESC[v11]=             Package to manage versions by scm tags (3.11)
   9 HOMEPAGE=               https://github.com/pypa/setuptools_scm/
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPIWHL/1d/66/8f42c941be949ef2b22fe905d850c794e7c170a526023612aad5f3a121ad
  14 DISTFILE[1]=            setuptools_scm-7.1.0-py3-none-any.whl:main
  15 DF_INDEX=               1
  16 SPKGS[py310]=           single
  17 SPKGS[v11]=             single
  18
  19 OPTIONS_AVAILABLE=      PY310 PY311
  20 OPTIONS_STANDARD=       none
  21 VOPTS[py310]=           PY310=ON PY311=OFF
  22 VOPTS[v11]=             PY310=OFF PY311=ON
  23
  24 DISTNAME=               setuptools_scm-7.1.0.dist-info
  25
  26 GENERATED=              yes
  27
  28 [PY310].RUN_DEPENDS_ON=                 python-packaging:single:py310
  29                                         python-setuptools:single:py310
  30                                         python-typing-extensions:single:py310
  31                                         python-tomli:single:py310
  32 [PY310].USES_ON=                        python:py310,wheel
  33
  34 [PY311].RUN_DEPENDS_ON=                 python-packaging:single:v11
  35                                         python-setuptools:single:v11
  36                                         python-typing-extensions:single:v11
  37 [PY311].USES_ON=                        python:v11,wheel
  38
  39 [FILE:3000:descriptions/desc.single]
  40 setuptools_scm
  41 ==============
  42
  43 setuptools_scm extracts Python package versions from git or
  44 hg metadata instead of declaring them as the version argument
  45 or in a SCM managed file.
  46
  47 Additionally setuptools_scm provides setuptools with a list of
  48 files that are managed by the SCM (i.e. it automatically adds all of
  49 the SCM-managed files to the sdist). Unwanted files must be excluded
  50 by discarding them via ``MANIFEST.in``.
  51
  52 setuptools_scm supports the following scm out of the box:
  53
  54 * git
  55 * mercurial
  56
  57 ``pyproject.toml`` usage
  58 ------------------------
  59
  60 The preferred way to configure setuptools_scm is to author
  61 settings in a ``tool.setuptools_scm section of pyproject.toml``.
  62
  63 This feature requires Setuptools 42 or later, released in Nov, 2019.
  64 If your project needs to support build from sdist on older versions
  65 of Setuptools, you will need to also implement the ``setup.py usage``
  66 for those legacy environments.
  67
  68 First, ensure that setuptools_scm is present during the project's
  69 built step by specifying it as one of the build requirements.
  70
  71 .. code:: toml
  72
  73     # pyproject.toml
  74     [build-system]
  75     requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2"]
  76
  77 That will be sufficient to require setuptools_scm for projects
  78 that support PEP 518 ([pip] and
  79 [pep517]). Many tools,
  80 especially those that invoke ``setup.py`` for any reason, may
  81 continue to rely on setup_requires. For maximum compatibility
  82 with those uses, consider also including a setup_requires directive
  83 (described below in ``setup.py usage and setup.cfg``).
  84
  85 To enable version inference, you need to set the version
  86 dynamically in the project section of ``pyproject.toml``:
  87
  88 .. code:: toml
  89
  90     # pyproject.toml
  91     [project]
  92     # version = "0.0.1"  # Remove any existing version parameter.
  93     dynamic = ["version"]
  94
  95 Then add this section to your ``pyproject.toml``:
  96
  97 .. code:: toml
  98
  99     # pyproject.toml
 100     [tool.setuptools_scm]
 101
 102 Including this section is comparable to supplying
 103 ``use_scm_version=True in setup.py``. Additionally,
 104 include arbitrary keyword arguments in that section
 105 to be supplied to ``get_version()``. For example:
 106
 107 .. code:: toml
 108
 109     # pyproject.toml
 110     [tool.setuptools_scm]
 111     write_to = "pkg/_version.py"
 112
 113 Where pkg is the name of your package.
 114
 115 If you need to confirm which version string is being generated
 116 or debug the configuration, you can install
 117 `setuptools-scm <https://github.com/pypa/setuptools_scm>`_
 118 directly in your working environment and run:
 119
 120 .. code-block:: shell
 121
 122     $ python -m setuptools_scm
 123
 124     # To explore other options, try:
 125     $ python -m setuptools_scm --help
 126
 127 ``setup.py`` usage (deprecated)
 128 -------------------------------
 129
 130 .. warning::
 131
 132    setup_requires has been deprecated in favor of ``pyproject.toml
 133
 134 The following settings are considered legacy behavior and
 135 superseded by the pyproject.toml`` usage, but for maximal
 136 compatibility, projects may also supply the configuration in
 137 this older form.
 138
 139 To use setuptools_scm just modify your project's ``setup.py`` file
 140
 141
 142 [FILE:116:distinfo]
 143 73988b6d848709e2af142aa48c986ea29592bbcfca5375678064708205253d8e        43829 setuptools_scm-7.1.0-py3-none-any.whl
 144