diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 5a0e5419..00000000 --- a/.gitattributes +++ /dev/null @@ -1 +0,0 @@ -ch_util/_version.py export-subst diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 207ab1bf..925f2505 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -13,10 +13,10 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Python 3.11 - uses: actions/setup-python@v2 + uses: actions/setup-python@v5 with: python-version: "3.11" @@ -30,11 +30,13 @@ jobs: strategy: matrix: - python-version: [3.9, 3.11] + python-version: [3.9, 3.12] runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 + with: + fetch-depth: 0 - name: Install apt dependencies run: | @@ -42,19 +44,12 @@ jobs: sudo apt-get install -y libopenmpi-dev openmpi-bin libhdf5-serial-dev - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - - name: Install pip dependencies - run: | - pip install wheel - pip install mpi4py - pip install numpy - pip install cython - pip install h5py - pip install --use-deprecated=legacy-resolver -e . --no-binary bitshuffle - pip install pytest + - name: Install ch_util + run: pip install -e .[test] --no-binary bitshuffle - name: Run tests run: pytest --ignore=tests/test_db.py tests/ @@ -64,7 +59,9 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 + with: + fetch-depth: 0 - name: Install apt dependencies run: | @@ -72,19 +69,15 @@ jobs: sudo apt-get install -y libopenmpi-dev openmpi-bin libhdf5-serial-dev - name: Set up Python 3.11 - uses: actions/setup-python@v2 + uses: actions/setup-python@v5 with: python-version: "3.11" - - name: Install pip dependencies - run: | - pip install wheel - pip install mpi4py - pip install numpy - pip install cython - pip install h5py - pip install --use-deprecated=legacy-resolver -e . --no-binary bitshuffle - pip install -r doc/requirements.txt + - name: Install ch_util + run: pip install -e . --no-binary bitshuffle + + - name: Install doc requirements + run: pip install -r doc/requirements.txt - name: Build sphinx docs run: sphinx-build -W -b html doc/ doc/_build/html diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml index f4ac3720..8b9fa29c 100644 --- a/.github/workflows/sphinx.yml +++ b/.github/workflows/sphinx.yml @@ -23,9 +23,8 @@ jobs: fetch-depth: 0 - name: Install pip requirements run: | - pip install -r requirements.txt - pip install -r doc/requirements.txt pip install . + pip install -r doc/requirements.txt - name: Sphinx build run: | git checkout -b gh-pages diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index ae8f14fe..00000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,55 +0,0 @@ -# [20.10.0](https://github.com/chime-experiment/ch_util/compare/v20.5.0...v20.10.0) (2020-10-21) - - -### Bug Fixes - -* **layout:** missing exception in layout db code ([b87de76](https://github.com/chime-experiment/ch_util/commit/b87de76bff058c7696c867bb0df4f3a9ebfd670a)) -* **tools:** Set non-CHIME input delays to zero, not NaN. ([a20e5f6](https://github.com/chime-experiment/ch_util/commit/a20e5f6bdac631da3b33a944cbaa2a2c285bd873)) - - -### Features - -* **chimeweather:** add support for chime_weather files ([#22](https://github.com/chime-experiment/ch_util/issues/22)) ([04d400c](https://github.com/chime-experiment/ch_util/commit/04d400ce45ded6812283e765d125e4c6545c576d)) -* **thermal:** Add amplitude thermal correction to cal_utils ([#25](https://github.com/chime-experiment/ch_util/issues/25)) ([ba36d37](https://github.com/chime-experiment/ch_util/commit/ba36d37294e32c8656eb1c9d44724a3e39b700b7)) -* **tools:** add a property to CorrInput to track static delays ([38991ab](https://github.com/chime-experiment/ch_util/commit/38991ab1eb1a5351ebbffe8234535076bda209e8)) -* **tools:** add delay calculation and decorrelation correction ([3c249e1](https://github.com/chime-experiment/ch_util/commit/3c249e1e19f84a6e2dc707920374911e4b937886)) - - - -# [20.5.0](https://github.com/chime-experiment/ch_util/compare/v0.3.0...v20.5.0) (2020-05-07) - -Note: we have switched to calendar versioning for this release. - -### Bug Fixes - -* **andata.Corrdata.from_acq_h5_fast:** Skip missing datasets. ([7a36b64](https://github.com/chime-experiment/ch_util/commit/7a36b64db97a2a2ac184f6e5ceac95832d382cf6)) -* **cal_utils:** cast inputs to float64 before passing to curve_fit. ([5462617](https://github.com/chime-experiment/ch_util/commit/5462617c04eac02afead99835aca6ddf8d325995)), closes [#10076](https://github.com/chime-experiment/ch_util/issues/10076) -* **cal_utils:** proper handling of abstract methods ([5f0e9ca](https://github.com/chime-experiment/ch_util/commit/5f0e9cab3bbaa8db4dfa595f74dbba96f6ccb5c2)) -* **connectdb:** remove symbol deleted upstream ([4f063cf](https://github.com/chime-experiment/ch_util/commit/4f063cf0a06584075156036964a96f0df16ad3dc)) -* **finder:** Fix imports. (pull request [#277](https://github.com/chime-experiment/ch_util/issues/277)) ([e74ea19](https://github.com/chime-experiment/ch_util/commit/e74ea19fb734c8d874f740417545e34af9915bc1)) -* **fluxcat:** fixes bug in freq sort and issues in python 3 ([f8c3ca5](https://github.com/chime-experiment/ch_util/commit/f8c3ca548740e9cb3c78e7c4607421067002c7e5)) -* **holography:** add import re to two functions which use it ([9c6fc8c](https://github.com/chime-experiment/ch_util/commit/9c6fc8c0cb7b3c538a1a691274c7dce782489c10)) -* **holography:** fix print statement bug ([26c4d9e](https://github.com/chime-experiment/ch_util/commit/26c4d9eaaf0b01ac9fa5ad1eeaccad5150e12414)) -* **pyproject.toml:** incorrectly quote dependency ([4baaf93](https://github.com/chime-experiment/ch_util/commit/4baaf934522c15b59e8c067bf12bfa4cb4937f26)) -* **README:** update path to repository in the README ([8a8e7ec](https://github.com/chime-experiment/ch_util/commit/8a8e7ec14e6ecc54a00a2022066f994725bf0046)) -* **setup.py:** missing requirement ([6b98a2c](https://github.com/chime-experiment/ch_util/commit/6b98a2c6c8a659e3a8c3bc9f6ade56c9be30e3d1)) -* **timing:** Fix bug that crashed on unicode inputs strings. ([#14](https://github.com/chime-experiment/ch_util/issues/14)) ([f98f2ab](https://github.com/chime-experiment/ch_util/commit/f98f2abd9b8020ec17654b16f9acbb8ca2426989)) -* **timing:** Robust check for gain dataset. ([a8dad3e](https://github.com/chime-experiment/ch_util/commit/a8dad3efae88cfdf41c04b035b79f3b4b9718166)) -* remove symbols removed from chimedb.core ([6c0cea4](https://github.com/chime-experiment/ch_util/commit/6c0cea4b2e088b12dffc007c291e8ecd00e4b81e)) -* use skyfield_wrapper to avoid re-downloading skyfield files ([af77d5e](https://github.com/chime-experiment/ch_util/commit/af77d5e80220a190b343aae36dfa686a0ccf873b)) - - -### Features - -* **andata:** add data classes for flaginput, gain, and digitalgain acquisitions. ([3026b25](https://github.com/chime-experiment/ch_util/commit/3026b25ee78e3a90da2dae86661c969a6db0907e)), closes [#289](https://github.com/chime-experiment/ch_util/issues/289) -* **andata:** improved conversion of index_maps and datasets to unicode ([41e5717](https://github.com/chime-experiment/ch_util/commit/41e571759b7ff22b17d0cc6a5ae2e0e4d2d42c89)) -* **CorrData:** add `prodstack` property to CorrData ([0ff31f4](https://github.com/chime-experiment/ch_util/commit/0ff31f4a81262e70f9c8d2eb7659bc46760d6eb3)) -* **CorrReader:** support reading when MPI distributed ([4f0891c](https://github.com/chime-experiment/ch_util/commit/4f0891cab154b286c2e06986023bd573485c6406)) -* **ephemeris:** Add a catalog of pulsar holography sources to source_dictionary. ([2c8cb15](https://github.com/chime-experiment/ch_util/commit/2c8cb156bd8f7b8587e4c70a502513d7019f3bd9)) -* **scripts:** Script for compiling a catalog of pulsar holography sources. ([af960ff](https://github.com/chime-experiment/ch_util/commit/af960ffd340864085a48fe23e85a3b69f0964409)) -* **tools:** add method `redefine_stack_index_map` ([c9f672a](https://github.com/chime-experiment/ch_util/commit/c9f672aa7f3781f06599da06e54d3b01e4e285ef)), closes [#282](https://github.com/chime-experiment/ch_util/issues/282) -* **tools:** change the default CHIME rotation to -0.071 degrees ([25dd134](https://github.com/chime-experiment/ch_util/commit/25dd1345795a0879eac93f4c1a844e307458531a)), closes [#11](https://github.com/chime-experiment/ch_util/issues/11) -* **update_psrcat:** create pulsar catalog that can be used by FluxCatalog ([ff7011a](https://github.com/chime-experiment/ch_util/commit/ff7011a0a64b4c655ea7e2ec37aa61ed9ece09b2)) -* **versioneer:** add versioneer for better version naming ([068efe8](https://github.com/chime-experiment/ch_util/commit/068efe8d5aed398161e2588f6ad6ef6a799b9458)) -* peewee 3 support ([fb184a3](https://github.com/chime-experiment/ch_util/commit/fb184a3a2e540cf6256576af8b1e6f98dc6e8558)) - diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index 46b4009a..00000000 --- a/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -include versioneer.py -include ch_util/_version.py diff --git a/ch_util/__init__.py b/ch_util/__init__.py index 2ed2ed50..2f1e1a59 100644 --- a/ch_util/__init__.py +++ b/ch_util/__init__.py @@ -24,6 +24,11 @@ tools """ -from . import _version +from importlib.metadata import version, PackageNotFoundError -__version__ = _version.get_versions()["version"] +try: + __version__ = version("ch_util") +except PackageNotFoundError: + # package is not installed + pass +del version, PackageNotFoundError diff --git a/ch_util/_version.py b/ch_util/_version.py deleted file mode 100644 index ecccc2c3..00000000 --- a/ch_util/_version.py +++ /dev/null @@ -1,716 +0,0 @@ -# This file helps to compute a version number in source trees obtained from -# git-archive tarball (such as those provided by githubs download-from-tag -# feature). Distribution tarballs (built by setup.py sdist) and build -# directories (produced by setup.py build) will contain a much shorter file -# that just contains the computed version number. - -# This file is released into the public domain. -# Generated by versioneer-0.29 -# https://github.com/python-versioneer/python-versioneer - -"""Git implementation of _version.py.""" - -import errno -import os -import re -import subprocess -import sys -from typing import Any, Callable, Dict, List, Optional, Tuple -import functools - - -def get_keywords() -> Dict[str, str]: - """Get the keywords needed to look up the version information.""" - # these strings will be replaced by git during git-archive. - # setup.py/versioneer.py will grep for the variable names, so they must - # each be defined on a line of their own. _version.py will just call - # get_keywords(). - git_refnames = "$Format:%d$" - git_full = "$Format:%H$" - git_date = "$Format:%ci$" - keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} - return keywords - - -class VersioneerConfig: - """Container for Versioneer configuration parameters.""" - - VCS: str - style: str - tag_prefix: str - parentdir_prefix: str - versionfile_source: str - verbose: bool - - -def get_config() -> VersioneerConfig: - """Create, populate and return the VersioneerConfig() object.""" - # these strings are filled in when 'setup.py versioneer' creates - # _version.py - cfg = VersioneerConfig() - cfg.VCS = "git" - cfg.style = "pep440" - cfg.tag_prefix = "v" - cfg.parentdir_prefix = "ch_util-" - cfg.versionfile_source = "ch_util/_version.py" - cfg.verbose = False - return cfg - - -class NotThisMethod(Exception): - """Exception raised if a method is not valid for the current scenario.""" - - -LONG_VERSION_PY: Dict[str, str] = {} -HANDLERS: Dict[str, Dict[str, Callable]] = {} - - -def register_vcs_handler(vcs: str, method: str) -> Callable: # decorator - """Create decorator to mark a method as the handler of a VCS.""" - - def decorate(f: Callable) -> Callable: - """Store f in HANDLERS[vcs][method].""" - if vcs not in HANDLERS: - HANDLERS[vcs] = {} - HANDLERS[vcs][method] = f - return f - - return decorate - - -def run_command( - commands: List[str], - args: List[str], - cwd: Optional[str] = None, - verbose: bool = False, - hide_stderr: bool = False, - env: Optional[Dict[str, str]] = None, -) -> Tuple[Optional[str], Optional[int]]: - """Call the given command(s).""" - assert isinstance(commands, list) - process = None - - popen_kwargs: Dict[str, Any] = {} - if sys.platform == "win32": - # This hides the console window if pythonw.exe is used - startupinfo = subprocess.STARTUPINFO() - startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW - popen_kwargs["startupinfo"] = startupinfo - - for command in commands: - try: - dispcmd = str([command] + args) - # remember shell=False, so use git.cmd on windows, not just git - process = subprocess.Popen( - [command] + args, - cwd=cwd, - env=env, - stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr else None), - **popen_kwargs, - ) - break - except OSError as e: - if e.errno == errno.ENOENT: - continue - if verbose: - print("unable to run %s" % dispcmd) - print(e) - return None, None - else: - if verbose: - print("unable to find command, tried %s" % (commands,)) - return None, None - stdout = process.communicate()[0].strip().decode() - if process.returncode != 0: - if verbose: - print("unable to run %s (error)" % dispcmd) - print("stdout was %s" % stdout) - return None, process.returncode - return stdout, process.returncode - - -def versions_from_parentdir( - parentdir_prefix: str, - root: str, - verbose: bool, -) -> Dict[str, Any]: - """Try to determine the version from the parent directory name. - - Source tarballs conventionally unpack into a directory that includes both - the project name and a version string. We will also support searching up - two directory levels for an appropriately named parent directory - """ - rootdirs = [] - - for _ in range(3): - dirname = os.path.basename(root) - if dirname.startswith(parentdir_prefix): - return { - "version": dirname[len(parentdir_prefix) :], - "full-revisionid": None, - "dirty": False, - "error": None, - "date": None, - } - rootdirs.append(root) - root = os.path.dirname(root) # up a level - - if verbose: - print( - "Tried directories %s but none started with prefix %s" - % (str(rootdirs), parentdir_prefix) - ) - raise NotThisMethod("rootdir doesn't start with parentdir_prefix") - - -@register_vcs_handler("git", "get_keywords") -def git_get_keywords(versionfile_abs: str) -> Dict[str, str]: - """Extract version information from the given file.""" - # the code embedded in _version.py can just fetch the value of these - # keywords. When used from setup.py, we don't want to import _version.py, - # so we do it with a regexp instead. This function is not used from - # _version.py. - keywords: Dict[str, str] = {} - try: - with open(versionfile_abs, "r") as fobj: - for line in fobj: - if line.strip().startswith("git_refnames ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["refnames"] = mo.group(1) - if line.strip().startswith("git_full ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["full"] = mo.group(1) - if line.strip().startswith("git_date ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["date"] = mo.group(1) - except OSError: - pass - return keywords - - -@register_vcs_handler("git", "keywords") -def git_versions_from_keywords( - keywords: Dict[str, str], - tag_prefix: str, - verbose: bool, -) -> Dict[str, Any]: - """Get version information from git keywords.""" - if "refnames" not in keywords: - raise NotThisMethod("Short version file found") - date = keywords.get("date") - if date is not None: - # Use only the last line. Previous lines may contain GPG signature - # information. - date = date.splitlines()[-1] - - # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant - # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 - # -like" string, which we must then edit to make compliant), because - # it's been around since git-1.5.3, and it's too difficult to - # discover which version we're using, or to work around using an - # older one. - date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - refnames = keywords["refnames"].strip() - if refnames.startswith("$Format"): - if verbose: - print("keywords are unexpanded, not using") - raise NotThisMethod("unexpanded keywords, not a git-archive tarball") - refs = {r.strip() for r in refnames.strip("()").split(",")} - # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of - # just "foo-1.0". If we see a "tag: " prefix, prefer those. - TAG = "tag: " - tags = {r[len(TAG) :] for r in refs if r.startswith(TAG)} - if not tags: - # Either we're using git < 1.8.3, or there really are no tags. We use - # a heuristic: assume all version tags have a digit. The old git %d - # expansion behaves like git log --decorate=short and strips out the - # refs/heads/ and refs/tags/ prefixes that would let us distinguish - # between branches and tags. By ignoring refnames without digits, we - # filter out many common branch names like "release" and - # "stabilization", as well as "HEAD" and "master". - tags = {r for r in refs if re.search(r"\d", r)} - if verbose: - print("discarding '%s', no digits" % ",".join(refs - tags)) - if verbose: - print("likely tags: %s" % ",".join(sorted(tags))) - for ref in sorted(tags): - # sorting will prefer e.g. "2.0" over "2.0rc1" - if ref.startswith(tag_prefix): - r = ref[len(tag_prefix) :] - # Filter out refs that exactly match prefix or that don't start - # with a number once the prefix is stripped (mostly a concern - # when prefix is '') - if not re.match(r"\d", r): - continue - if verbose: - print("picking %s" % r) - return { - "version": r, - "full-revisionid": keywords["full"].strip(), - "dirty": False, - "error": None, - "date": date, - } - # no suitable tags, so version is "0+unknown", but full hex is still there - if verbose: - print("no suitable tags, using unknown + full revision id") - return { - "version": "0+unknown", - "full-revisionid": keywords["full"].strip(), - "dirty": False, - "error": "no suitable tags", - "date": None, - } - - -@register_vcs_handler("git", "pieces_from_vcs") -def git_pieces_from_vcs( - tag_prefix: str, root: str, verbose: bool, runner: Callable = run_command -) -> Dict[str, Any]: - """Get version from 'git describe' in the root of the source tree. - - This only gets called if the git-archive 'subst' keywords were *not* - expanded, and _version.py hasn't already been rewritten with a short - version string, meaning we're inside a checked out source tree. - """ - GITS = ["git"] - if sys.platform == "win32": - GITS = ["git.cmd", "git.exe"] - - # GIT_DIR can interfere with correct operation of Versioneer. - # It may be intended to be passed to the Versioneer-versioned project, - # but that should not change where we get our version from. - env = os.environ.copy() - env.pop("GIT_DIR", None) - runner = functools.partial(runner, env=env) - - _, rc = runner(GITS, ["rev-parse", "--git-dir"], cwd=root, hide_stderr=not verbose) - if rc != 0: - if verbose: - print("Directory %s not under git control" % root) - raise NotThisMethod("'git rev-parse --git-dir' returned error") - - # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] - # if there isn't one, this yields HEX[-dirty] (no NUM) - describe_out, rc = runner( - GITS, - [ - "describe", - "--tags", - "--dirty", - "--always", - "--long", - "--match", - f"{tag_prefix}[[:digit:]]*", - ], - cwd=root, - ) - # --long was added in git-1.5.5 - if describe_out is None: - raise NotThisMethod("'git describe' failed") - describe_out = describe_out.strip() - full_out, rc = runner(GITS, ["rev-parse", "HEAD"], cwd=root) - if full_out is None: - raise NotThisMethod("'git rev-parse' failed") - full_out = full_out.strip() - - pieces: Dict[str, Any] = {} - pieces["long"] = full_out - pieces["short"] = full_out[:7] # maybe improved later - pieces["error"] = None - - branch_name, rc = runner(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], cwd=root) - # --abbrev-ref was added in git-1.6.3 - if rc != 0 or branch_name is None: - raise NotThisMethod("'git rev-parse --abbrev-ref' returned error") - branch_name = branch_name.strip() - - if branch_name == "HEAD": - # If we aren't exactly on a branch, pick a branch which represents - # the current commit. If all else fails, we are on a branchless - # commit. - branches, rc = runner(GITS, ["branch", "--contains"], cwd=root) - # --contains was added in git-1.5.4 - if rc != 0 or branches is None: - raise NotThisMethod("'git branch --contains' returned error") - branches = branches.split("\n") - - # Remove the first line if we're running detached - if "(" in branches[0]: - branches.pop(0) - - # Strip off the leading "* " from the list of branches. - branches = [branch[2:] for branch in branches] - if "master" in branches: - branch_name = "master" - elif not branches: - branch_name = None - else: - # Pick the first branch that is returned. Good or bad. - branch_name = branches[0] - - pieces["branch"] = branch_name - - # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] - # TAG might have hyphens. - git_describe = describe_out - - # look for -dirty suffix - dirty = git_describe.endswith("-dirty") - pieces["dirty"] = dirty - if dirty: - git_describe = git_describe[: git_describe.rindex("-dirty")] - - # now we have TAG-NUM-gHEX or HEX - - if "-" in git_describe: - # TAG-NUM-gHEX - mo = re.search(r"^(.+)-(\d+)-g([0-9a-f]+)$", git_describe) - if not mo: - # unparsable. Maybe git-describe is misbehaving? - pieces["error"] = "unable to parse git-describe output: '%s'" % describe_out - return pieces - - # tag - full_tag = mo.group(1) - if not full_tag.startswith(tag_prefix): - if verbose: - fmt = "tag '%s' doesn't start with prefix '%s'" - print(fmt % (full_tag, tag_prefix)) - pieces["error"] = "tag '%s' doesn't start with prefix '%s'" % ( - full_tag, - tag_prefix, - ) - return pieces - pieces["closest-tag"] = full_tag[len(tag_prefix) :] - - # distance: number of commits since tag - pieces["distance"] = int(mo.group(2)) - - # commit: short hex revision ID - pieces["short"] = mo.group(3) - - else: - # HEX: no tags - pieces["closest-tag"] = None - out, rc = runner(GITS, ["rev-list", "HEAD", "--left-right"], cwd=root) - pieces["distance"] = len(out.split()) # total number of commits - - # commit date: see ISO-8601 comment in git_versions_from_keywords() - date = runner(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[0].strip() - # Use only the last line. Previous lines may contain GPG signature - # information. - date = date.splitlines()[-1] - pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - - return pieces - - -def plus_or_dot(pieces: Dict[str, Any]) -> str: - """Return a + if we don't already have one, else return a .""" - if "+" in pieces.get("closest-tag", ""): - return "." - return "+" - - -def render_pep440(pieces: Dict[str, Any]) -> str: - """Build up version string, with post-release "local version identifier". - - Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you - get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty - - Exceptions: - 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += plus_or_dot(pieces) - rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0+untagged.%d.g%s" % (pieces["distance"], pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def render_pep440_branch(pieces: Dict[str, Any]) -> str: - """TAG[[.dev0]+DISTANCE.gHEX[.dirty]] . - - The ".dev0" means not master branch. Note that .dev0 sorts backwards - (a feature branch will appear "older" than the master branch). - - Exceptions: - 1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - if pieces["branch"] != "master": - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0" - if pieces["branch"] != "master": - rendered += ".dev0" - rendered += "+untagged.%d.g%s" % (pieces["distance"], pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def pep440_split_post(ver: str) -> Tuple[str, Optional[int]]: - """Split pep440 version string at the post-release segment. - - Returns the release segments before the post-release and the - post-release version number (or -1 if no post-release segment is present). - """ - vc = str.split(ver, ".post") - return vc[0], int(vc[1] or 0) if len(vc) == 2 else None - - -def render_pep440_pre(pieces: Dict[str, Any]) -> str: - """TAG[.postN.devDISTANCE] -- No -dirty. - - Exceptions: - 1: no tags. 0.post0.devDISTANCE - """ - if pieces["closest-tag"]: - if pieces["distance"]: - # update the post release segment - tag_version, post_version = pep440_split_post(pieces["closest-tag"]) - rendered = tag_version - if post_version is not None: - rendered += ".post%d.dev%d" % (post_version + 1, pieces["distance"]) - else: - rendered += ".post0.dev%d" % (pieces["distance"]) - else: - # no commits, use the tag as the version - rendered = pieces["closest-tag"] - else: - # exception #1 - rendered = "0.post0.dev%d" % pieces["distance"] - return rendered - - -def render_pep440_post(pieces: Dict[str, Any]) -> str: - """TAG[.postDISTANCE[.dev0]+gHEX] . - - The ".dev0" means dirty. Note that .dev0 sorts backwards - (a dirty tree will appear "older" than the corresponding clean one), - but you shouldn't be releasing software with -dirty anyways. - - Exceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "g%s" % pieces["short"] - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += "+g%s" % pieces["short"] - return rendered - - -def render_pep440_post_branch(pieces: Dict[str, Any]) -> str: - """TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] . - - The ".dev0" means not master branch. - - Exceptions: - 1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["branch"] != "master": - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "g%s" % pieces["short"] - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["branch"] != "master": - rendered += ".dev0" - rendered += "+g%s" % pieces["short"] - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def render_pep440_old(pieces: Dict[str, Any]) -> str: - """TAG[.postDISTANCE[.dev0]] . - - The ".dev0" means dirty. - - Exceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - return rendered - - -def render_git_describe(pieces: Dict[str, Any]) -> str: - """TAG[-DISTANCE-gHEX][-dirty]. - - Like 'git describe --tags --dirty --always'. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render_git_describe_long(pieces: Dict[str, Any]) -> str: - """TAG-DISTANCE-gHEX[-dirty]. - - Like 'git describe --tags --dirty --always -long'. - The distance/hash is unconditional. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render(pieces: Dict[str, Any], style: str) -> Dict[str, Any]: - """Render the given version pieces into the requested style.""" - if pieces["error"]: - return { - "version": "unknown", - "full-revisionid": pieces.get("long"), - "dirty": None, - "error": pieces["error"], - "date": None, - } - - if not style or style == "default": - style = "pep440" # the default - - if style == "pep440": - rendered = render_pep440(pieces) - elif style == "pep440-branch": - rendered = render_pep440_branch(pieces) - elif style == "pep440-pre": - rendered = render_pep440_pre(pieces) - elif style == "pep440-post": - rendered = render_pep440_post(pieces) - elif style == "pep440-post-branch": - rendered = render_pep440_post_branch(pieces) - elif style == "pep440-old": - rendered = render_pep440_old(pieces) - elif style == "git-describe": - rendered = render_git_describe(pieces) - elif style == "git-describe-long": - rendered = render_git_describe_long(pieces) - else: - raise ValueError("unknown style '%s'" % style) - - return { - "version": rendered, - "full-revisionid": pieces["long"], - "dirty": pieces["dirty"], - "error": None, - "date": pieces.get("date"), - } - - -def get_versions() -> Dict[str, Any]: - """Get version information or return default if unable to do so.""" - # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have - # __file__, we can work backwards from there to the root. Some - # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which - # case we can only use expanded keywords. - - cfg = get_config() - verbose = cfg.verbose - - try: - return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, verbose) - except NotThisMethod: - pass - - try: - root = os.path.realpath(__file__) - # versionfile_source is the relative path from the top of the source - # tree (where the .git directory might live) to this file. Invert - # this to find the root from __file__. - for _ in cfg.versionfile_source.split("/"): - root = os.path.dirname(root) - except NameError: - return { - "version": "0+unknown", - "full-revisionid": None, - "dirty": None, - "error": "unable to find root of source tree", - "date": None, - } - - try: - pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) - return render(pieces, cfg.style) - except NotThisMethod: - pass - - try: - if cfg.parentdir_prefix: - return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) - except NotThisMethod: - pass - - return { - "version": "0+unknown", - "full-revisionid": None, - "dirty": None, - "error": "unable to compute version", - "date": None, - } diff --git a/pyproject.toml b/pyproject.toml index 0f2207a1..2126f766 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,10 +1,46 @@ [build-system] -requires = ['setuptools', 'wheel', 'versioneer[toml]'] - -[tool.versioneer] -VCS = "git" -style = "pep440" -versionfile_source = "ch_util/_version.py" -versionfile_build = "ch_util/_version.py" -tag_prefix = "v" -parentdir_prefix = "ch_util-" +requires = ["setuptools>=61.0.0", "wheel", "setuptools-git-versioning"] +build-backend = "setuptools.build_meta" + +[project] +name = "ch_util" +authors = [ + {name = "The CHIME Collaboration", email = "dvw@phas.ubc.ca"} +] +description = "Utilities for CHIME" +requires-python = ">=3.9" +dynamic = ["readme", "version"] +license = {file = "LICENSE"} +dependencies = [ + "caput[compression] @ git+https://github.com/radiocosmology/caput.git", + "chimedb @ git+https://github.com/chime-experiment/chimedb.git", + "chimedb.data_index @ git+https://github.com/chime-experiment/chimedb_di.git", + "chimedb.dataflag @ git+https://github.com/chime-experiment/chimedb_dataflag.git", + "chimedb.dataset @ git+https://github.com/chime-experiment/chimedb_dataset.git", + "bitshuffle", + "h5py", + "matplotlib", + "mpi4py", + "networkx >= 2.0", + "numpy >= 1.16,<2", + "peewee >= 3.14.1", + "scipy", + "skyfield >= 1.10" +] + +[project.optional-dependencies] +chimedb_config = [ + "chimedb.config @ git+ssh://git@github.com/chime-experiment/chimedb_config.git" +] +test = [ + "pytest >= 7.0" +] + +[tool.setuptools.package-data] +"ch_util.catalogs" = ["*.json"] + +[tool.setuptools.dynamic] +readme = {file = ["README.md"], content-type = "text/markdown"} + +[tool.setuptools-git-versioning] +enabled = true diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index b75f68e5..00000000 --- a/requirements.txt +++ /dev/null @@ -1,14 +0,0 @@ -chimedb @ git+https://github.com/chime-experiment/chimedb.git -chimedb.data_index @ git+https://github.com/chime-experiment/chimedb_di.git -chimedb.dataflag @ git+https://github.com/chime-experiment/chimedb_dataflag.git -chimedb.dataset @ git+https://github.com/chime-experiment/chimedb_dataset.git -matplotlib -numpy >= 1.16,<2 -scipy -networkx >= 2.0 -h5py -peewee >= 3.14.1 -bitshuffle -caput[compression] @ git+https://github.com/radiocosmology/caput.git -skyfield >= 1.10 -mpi4py diff --git a/setup.py b/setup.py deleted file mode 100644 index 24ce8903..00000000 --- a/setup.py +++ /dev/null @@ -1,33 +0,0 @@ -from setuptools import setup, find_packages - -import versioneer - -ch_util_data = { - "ch_util": ["catalogs/*.json"], -} - -# Load the PEP508 formatted requirements from the requirements.txt file. Needs -# pip version > 19.0 -with open("requirements.txt", "r") as fh: - requires = fh.readlines() - -setup( - name="ch_util", - version=versioneer.get_version(), - cmdclass=versioneer.get_cmdclass(), - packages=find_packages(), - python_requires=">=3.9", - install_requires=requires, - extras_require={ - "chimedb_config": [ - "chimedb.config @ git+ssh://git@github.com/chime-experiment/chimedb_config.git" - ] - }, - package_data=ch_util_data, - # metadata for upload to PyPI - author="CHIME collaboration", - author_email="richard@phas.ubc.ca", - description="Utilities for CHIME.", - license="MIT", - url="https://bitbucket.org/chime/ch_util", -)