versioningit
  • How it Works
    • Version Calculation
    • Build Integration
      • Setting the Version
      • onbuild Step
  • Configuration
    • Specifying the Method
    • The [tool.versioningit.vcs] Subtable
      • "git"
      • "git-archive"
      • "hg"
    • The [tool.versioningit.tag2version] Subtable
    • The [tool.versioningit.next-version] Subtable
    • The [tool.versioningit.format] Subtable
    • The [tool.versioningit.template-fields] Subtable
    • The [tool.versioningit.write] Subtable
    • Enabling & Configuring the onbuild Step
      • Using onbuild with setuptools
      • Using onbuild with Hatch
      • onbuild Configuration Options
    • tool.versioningit.default-version
    • Log Level Environment Variable
  • Getting Package Version at Runtime
  • Hatch Integration
  • Command
    • Options
  • Library API
    • High-Level Functions and Classes
      • get_version()
      • get_next_version()
      • get_cmdclasses()
      • versioningit.cmdclass.sdist
      • versioningit.cmdclass.build_py
    • Low-Level Class
      • Versioningit
        • Versioningit.from_project_dir()
        • Versioningit.get_version()
        • Versioningit.run()
        • Versioningit.do_vcs()
        • Versioningit.do_tag2version()
        • Versioningit.do_next_version()
        • Versioningit.do_format()
        • Versioningit.do_template_fields()
        • Versioningit.do_write()
        • Versioningit.do_onbuild()
    • Exceptions
      • Error
      • ConfigError
      • InvalidTagError
      • InvalidVersionError
      • MethodError
      • NoTagError
      • NotSdistError
      • NotVCSError
      • NotVersioningitError
    • Utilities
      • VCSDescription
        • VCSDescription.branch
        • VCSDescription.fields
        • VCSDescription.state
        • VCSDescription.tag
      • Report
        • Report.base_version
        • Report.description
        • Report.next_version
        • Report.template_fields
        • Report.using_default_version
        • Report.version
      • FallbackReport
        • FallbackReport.version
      • get_version_from_pkg_info()
      • run_onbuild()
      • get_template_fields_from_distribution()
    • Passing Explicit Configuration
  • Writing Your Own Methods
    • vcs
    • tag2version
    • next-version
    • format
    • template-fields
    • write
    • onbuild
      • OnbuildFileProvider
        • OnbuildFileProvider.get_file()
      • OnbuildFile
        • OnbuildFile.open()
    • Distributing Your Methods in an Extension Package
  • Notes
    • Restrictions & Caveats
    • Backwards Compatibility Policy
  • Changelog
    • v3.1.3 (2025-05-12)
    • v3.1.2 (2024-07-20)
    • v3.1.1 (2024-04-29)
    • v3.1.0 (2024-03-16)
    • v3.0.0 (2023-12-13)
    • v2.3.0 (2023-11-19)
    • v2.2.1 (2023-09-22)
    • v2.2.0 (2023-02-11)
    • v2.1.0 (2022-10-25)
    • v2.0.1 (2022-08-01)
    • v2.0.0 (2022-06-12)
    • v1.1.2 (2022-08-12)
    • v1.1.1 (2022-04-08)
    • v1.1.0 (2022-03-03)
    • v1.0.0 (2022-02-06)
    • v0.3.3 (2022-02-04)
    • v0.3.2 (2022-01-16)
    • v0.3.1 (2022-01-02)
    • v0.3.0 (2021-09-27)
    • v0.2.1 (2021-08-02)
    • v0.2.0 (2021-07-13)
    • v0.1.0 (2021-07-08)
    • v0.1.0a1 (2021-07-05)
versioningit
  • Search

© Copyright 2021-2025 John Thorvald Wodder II. Last updated on 2025 May 12.

Built with Sphinx using a theme provided by Read the Docs.