How can use the 'version' specified in pyproject.toml file in my python typer program?

Question

i have a very simple python/typer program.

i also use the poetry as build tool.

This is a snippet of my pyproject.toml file:

name = "cat-cli"
version = "0.1.3"
description = "Cat Cli"

Is there a simple way get the version number specified in the toml file into my python program?

Thank you in advance

Sestos

Answer 1

The canonical way of getting the version number of an installed package, is to use importlib.metadata or its backport importlib-metadata if you are on Python <3.8.

try:
    from importlib import metadata
except ImportError:
    import importlib_metadata as metadata

version = metadata.version("mypackage")

Veroniqueverras

Is there a good way to retrieve mypackage? – Hypoblast

@Hypoblast See my answer below. – Kenna

Answer 2

You could use a package like tomli to read the poetry configuration file and get the version using something like:

import tomli

with open("pyproject.toml", mode="r") as config:
    toml_file = tomli.load(config)

toml_file['tool.poetry']['version'] should get you the version string, assuming you have the tool.poetry table.

Follow this guide to get you started

Phobe

Answer 3

This snippet will show you the include flag to use for arrayobject.h

import numpy as np
import sys
from pathlib import Path

numpy_include_path = Path(np.get_include())
arrayobject_h = numpy_include_path / 'numpy' / 'arrayobject.h'

if arrayobject_h.exists():
    print(f"-I{numpy_include_path}")
else:
    print('arrayobject.h not found :-()')

Unessential

Answer 4

import importlib_metadata as metadata

__version__ = metadata.version(__package__.split(".")[0])

If your file is at the root of the package you may not need to split.

Note that you’ll need to run poetry install for metadata to see the package, or you’ll get

importlib.metadata.PackageNotFoundError: No package metadata was found for PACKAGE_NAME

Kenna