Skip to main content

Version discovery for Python packages

Project description

DiscoverVersion

This package automatically discover version information for a package. It tries the following option to get the version of the package:

  • Inspect a PKG-INFO file
  • Ask git, if the current directory is a git-repository
  • Ask importlib.metadata

It is intended as a lightweight replacement for setuptools_scm.

Usage

To use automatic version discovery with your build system of choice , here flit, add the following lines to your pyproject.toml:

[build-system]
requires = ["flit_core>=3.2", "DiscoverVersion"]
build-backend = "flit_core.buildapi"

[project]
dynamic = ['version']
dependencies = ['DiscoverVersion']

The add the following to your toplevel __init__.py:

from DiscoverVersion import get_version

__version__ = get_version('my_package_name')

Note that it is important to hard code the name of your package in the call to get_version.

Tests

Before being able to run tests, you need to execute

pip install -e .[test] 

to editably install the code.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

discoverversion-0.2.5.tar.gz (3.5 kB view details)

Uploaded Source

File details

Details for the file discoverversion-0.2.5.tar.gz.

File metadata

  • Download URL: discoverversion-0.2.5.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for discoverversion-0.2.5.tar.gz
Algorithm Hash digest
SHA256 c6df860641625f08c173def7c9a5ee752699503a9ee70612285c9ba6e0e4d563
MD5 786d5cb05b058fc7a1d8af428ef46c25
BLAKE2b-256 945113258e89e3ebf0f94a788279774782b70c816084f7c23ae5c68512bfba0f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page