Skip to content

Commit

Permalink
feat!: use setuptools-scm, capture version at package root (#381)
Browse files Browse the repository at this point in the history
* use setuptools-scm for versioning instead of explicit declaration in
version.py
* provide version in package root instead of version module
  • Loading branch information
korikuzma authored Jul 15, 2024
1 parent 65d8f43 commit bee974c
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,9 @@
autodoc_preserve_defaults = True

# -- get version -------------------------------------------------------------
from importlib.metadata import version
from metakb import __version__

release = version = version("metakb")
release = version = __version__

# -- linkcode ----------------------------------------------------------------
def linkcode_resolve(domain, info):
Expand Down
5 changes: 2 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,10 @@ Source = "https://github.com/cancervariants/metakb"
metakb = "metakb.cli:cli"

[build-system]
requires = ["setuptools>=64"]
requires = ["setuptools>=64", "setuptools_scm>=8"]
build-backend = "setuptools.build_meta"

[tool.setuptools.dynamic]
version = {attr = "metakb.version.__version__"}
[tool.setuptools_scm]

[tool.setuptools.packages.find]
where = ["src"]
Expand Down
9 changes: 9 additions & 0 deletions src/metakb/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
"""The MetaKB package."""
from importlib.metadata import PackageNotFoundError, version
from pathlib import Path

APP_ROOT = Path(__file__).resolve().parents[0]

# default date format for all saved data files
DATE_FMT = "%Y%m%d"


try:
__version__ = version("metakb")
except PackageNotFoundError:
__version__ = "unknown"
finally:
del version, PackageNotFoundError
2 changes: 1 addition & 1 deletion src/metakb/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
from fastapi import FastAPI, Query
from fastapi.openapi.utils import get_openapi

from metakb import __version__
from metakb.log_handle import configure_logs
from metakb.query import QueryHandler
from metakb.version import __version__

query = QueryHandler()

Expand Down
2 changes: 1 addition & 1 deletion src/metakb/schemas/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

from pydantic import BaseModel, ConfigDict, StrictStr

from metakb import __version__
from metakb.schemas.variation_statement import VariantTherapeuticResponseStudy
from metakb.version import __version__


class ServiceMeta(BaseModel):
Expand Down
2 changes: 0 additions & 2 deletions src/metakb/version.py

This file was deleted.

0 comments on commit bee974c

Please sign in to comment.