Merge pull request #103 from MODFLOW-USGS/v1.0.0

Release 1.0.0 Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: w-bonelli <[email protected]>
MODFLOW-USGS · Aug 5, 2023 · e92682a · e92682a
2 parents 9a0fffd + a4c2dc5
commit e92682a
Show file tree

Hide file tree

Showing 20 changed files with 431 additions and 496 deletions.
diff --git a/HISTORY.md b/HISTORY.md
@@ -1,3 +1,13 @@
+### Version 1.0.0
+
+#### New features
+
+* [feat(ostags)](https://github.com/MODFLOW-USGS/modflow-devtools/commit/33ab22a5f7e1c88258038e9881f22c6cd537965c): Add OS tag conversion utilities (#99). Committed by w-bonelli on 2023-08-05.
+
+#### Refactoring
+
+* [refactor](https://github.com/MODFLOW-USGS/modflow-devtools/commit/07bd60fff92a0dab08721c167293344a827d6345): Multiple (#100). Committed by w-bonelli on 2023-08-05.
+
 ### Version 0.3.0
 
 #### Refactoring

diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ Python development tools for MODFLOW 6.
 
 This is a small toolkit for developing MODFLOW 6, FloPy, and related projects. It includes standalone utilities and optional [Pytest](https://github.com/pytest-dev/pytest) extensions.
 
-Standalone utilities include a very minimal GitHub API client, mainly for retrieving release information and downloading assets, and a `ZipFile` subclass that [preserves file permissions](https://stackoverflow.com/questions/39296101/python-zipfile-removes-execute-permissions-from-binaries) (workaround for [Python #15795](https://bugs.python.org/issue15795))
+The former include a very minimal GitHub API client for retrieving release information and downloading assets, a `ZipFile` subclass that [preserves file permissions](https://stackoverflow.com/questions/39296101/python-zipfile-removes-execute-permissions-from-binaries) (workaround for [Python #15795](https://bugs.python.org/issue15795)), and other release/distribution-related tools.
 
 Pytest features include:
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -8,7 +8,7 @@
 
 project = "modflow-devtools"
 author = "MODFLOW Team"
-release = "0.3.0"
+release = "1.0.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

diff --git a/docs/index.rst b/docs/index.rst
@@ -19,7 +19,6 @@ The `modflow-devtools` package provides a set of tools for developing and testin
    :maxdepth: 2
    :caption: Test fixtures
 
-   md/cases.md
    md/executables.md
    md/fixtures.md
    md/markers.md
@@ -30,6 +29,7 @@ The `modflow-devtools` package provides a set of tools for developing and testin
    :caption: Miscellaneous
 
    md/download.md
+   md/ostags.md
    md/zip.md
 
 

diff --git a/docs/md/cases.md b/docs/md/cases.md
diff --git a/docs/md/executables.md b/docs/md/executables.md
@@ -7,7 +7,7 @@ The `Executables` class maps executable names to paths on the filesystem. This i
 For example, assuming development binaries live in `bin` relative to the project root (as is currently the convention for `modflow6`), the following `pytest` fixtures could be defined:
 
 ```python
-from modflow_devtools.executables import build_default_exe_dict, Executables
+from modflow_devtools.executables import Executables
 
 @pytest.fixture(scope="session")
 def bin_path() -> Path:
@@ -16,7 +16,10 @@ def bin_path() -> Path:
 
 @pytest.fixture(scope="session")
 def targets(bin_path) -> Executables:
-    return Executables(**build_default_exe_dict(bin_path))
+    exes = {
+        # ...map names to paths
+    }
+    return Executables(**exes)
 ```
 
 The `targets` fixture can then be injected into test functions:
@@ -27,8 +30,6 @@ def test_targets(targets):
     assert targets["mf6"] == targets.mf6
 ```
 
-The `build_default_exe_dict` function is provided to create the default executable mapping used by MODFLOW 6 autotests.
-
 There is also a convenience function for getting a program's version string. The function will automatically strip the program name from the output (assumed delimited with `:`).
 
 ```python

diff --git a/docs/md/ostags.md b/docs/md/ostags.md
@@ -0,0 +1,45 @@
+# OS Tags
+
+MODFLOW 6, Python3, build servers, and other systems may refer to operating systems by different names. Utilities are provided in the `modflow_devtools.ostags` module to convert between
+
+- the output of `platform.system()`
+- GitHub Actions `runner.os` tags
+- MODFLOW 6 release asset OS tags
+
+Only Linux, Mac and Windows are supported.
+
+## Tag specification
+
+Python3's `platform.system()` returns "Linux", "Darwin", and "Windows", respectively.
+
+GitHub Actions (e.g. `runner.os` context) use "Linux", "macOS" and "Windows".
+
+MODFLOW 6 release asset names end with "linux", "mac" or "win64".
+
+## Getting tags
+
+To get the MODFLOW 6 or GitHub tag for the current OS, use:
+
+- `get_modflow_ostag()`
+- `get_github_ostag()`
+
+## Converting tags
+
+Conversion functions are available for each direction:
+
+- `python_to_modflow_ostag(tag)`
+- `modflow_to_python_ostag(tag)`
+- `modflow_to_github_ostag(tag)`
+- `github_to_modflow_ostag(tag)`
+- `python_to_github_ostag(tag)`
+- `github_to_python_ostag(tag)`
+
+Alternatively:
+
+```python
+OSTag.convert(platform.system(), "py2mf")
+```
+
+The second argument specifies the mapping in format `<source>2<target>`, where `<source>` and `<target>` may take values `py`, `mf`, or `gh`.
+
+**Note**: source and target must be different.
diff --git a/modflow_devtools/__init__.py b/modflow_devtools/__init__.py
@@ -1,6 +1,6 @@
 __author__ = "Joseph D. Hughes"
-__date__ = "Aug 04, 2023"
-__version__ = "0.3.0"
+__date__ = "Aug 05, 2023"
+__version__ = "1.0.0"
 __maintainer__ = "Joseph D. Hughes"
 __email__ = "[email protected]"
 __status__ = "Production"

diff --git a/modflow_devtools/case.py b/modflow_devtools/case.py