Skip to content

Commit e808c73

Browse files
committed
Merge branch 'main' into develop
2 parents af5749d + d40a0bc commit e808c73

88 files changed

Lines changed: 4248 additions & 1240 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/appdir-jekyll-update.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@ jobs:
2020
owner: 'clamsproject',
2121
repo: 'apps',
2222
event_type: 'appdir-update',
23-
client_payload: ${{ toJSON(github.event) }}
23+
client_payload: {}
2424
})
2525
console.log(result);

CHANGELOG.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,105 @@
11

2+
## releasing 1.3.2 (2025-07-26)
3+
### Overview
4+
Patch release, mainly to support new MMIF spec and corresponding `mmif-python` SDK versions, with more base images with HF libraries and miscellaneous fixes.
5+
6+
### Additions
7+
* Now ships with `mmif-python` 1.1.1 and spec 1.1.0.
8+
* Base container images with HF `transformers` pre-installed are now available (https://github.com/clamsproject/clams-python/pull/247).
9+
10+
### Changes
11+
* Minimal python version is now 3.10 (https://github.com/clamsproject/clams-python/issues/228).
12+
* Installation process is updated to support python 3.12 and newer.
13+
* Minor bugfixes and documentation improvements.
14+
15+
16+
## releasing 1.3.1 (2024-07-29)
17+
### Overview
18+
This patch includes update to the latest `mmif-python` which contains a hot fix for a critical bug.
19+
20+
### Changes
21+
- based on `mmif-python==1.0.19`
22+
23+
24+
## releasing 1.3.0 (2024-07-22)
25+
### Overview
26+
This version added two universal runtime parameters that make some aspects of the runtime environment are recorded in the views' metadata.
27+
28+
29+
### Additions
30+
- `hwFetch` universal parameter will record CPU architecture and CUDA devices in `view.metadata.appRunningHardware`
31+
- `runningTime` universal parameter will record app's running time in `view.metadata.appRunningTime`
32+
- See https://github.com/clamsproject/clams-python/issues/236 for rationale behind
33+
34+
35+
36+
## releasing 1.2.6 (2024-07-15)
37+
### Overview
38+
Patch release to update mmif SDK version, and minor improvements
39+
40+
### Additions
41+
- `clams source --help` will display formatting guidelines for docloc plugins, if provided by the plugin developer (https://github.com/clamsproject/clams-python/issues/235)
42+
43+
### Changes
44+
- now based on `mmif-python` 1.0.18
45+
- bug fix "raw" runtime parameters weren't properly recorded when an app fails to refine the parameters (https://github.com/clamsproject/clams-python/issues/232)
46+
47+
48+
## releasing 1.2.5 (2024-06-26)
49+
### Overview
50+
Patch release to fix an error in app cookie cutter, also updated to the latest MMIF and mmif-python.
51+
52+
### Changes
53+
- updated `mmif-python` to 1.0.17
54+
- fixed `Containerfile` from the app cookie cutter wasn't building an image due to an error
55+
56+
## releasing 1.2.4 (2024-06-14)
57+
### Overview
58+
Patches bug in `clams develop` command and updated in documentation and `mmif-python` version
59+
60+
61+
### Changes
62+
* fixed `clams develop` command not working to start a new app from scratch
63+
* updated `mmif-python` version to 1.0.16
64+
* updated app development documentation
65+
66+
67+
## releasing 1.2.3 (2024-06-07)
68+
### Overview
69+
This version includes significant change to app development template, with some other changes
70+
71+
### Additions
72+
- `clams develop` cookie cutter now includes `cli.py` that enables secondary entry point to the app (https://github.com/clamsproject/clams-python/issues/198).
73+
74+
### Changes
75+
- `clams develop` command now has `--update` flag to help "reheating" an existing app directory with latest template
76+
- minor bug fix related to interpreting boolean runtime parameter values
77+
- base container images now based on debian 12
78+
- base container image and containerfile in app template now hardcode XDG_CACHE_DIR to `/cache` for consistent cache bind-mount (https://github.com/clamsproject/clams-python/issues/221)
79+
- base opencv container image now use opencv 4.10
80+
- updated to `mmif-python` 1.0.15
81+
82+
83+
## releasing 1.2.2 (2024-05-14)
84+
### Overview
85+
This is minor patch with bug fix for parameter handling
86+
87+
### Changes
88+
* fixed bug when passing default values for a `multivalued=True` parameter, values are not properly set (#219)
89+
* updated to the latest `mmif-python` (1.0.14)
90+
91+
92+
## releasing 1.2.1 (2024-04-21)
93+
### Overview
94+
This release includes documentation updates and bug fixes
95+
96+
### Additions
97+
* lots of details were added to app metadata documentation for app developers (https://github.com/clamsproject/clams-python/issues/201)
98+
99+
### Changes
100+
* fixed a bug where raw user input parameters with `multivalued=True` were not fully recorded in the output MMIF view metadata (https://github.com/clamsproject/clams-python/issues/214)
101+
102+
2103
## releasing 1.2.0 (2024-04-11)
3104
### Overview
4105
This is a minor release that brings improved portability of `clams source` command but also breaks some backward compatibility. If your app is based on clams-python 1.0.x or 1.1.x, please read the changelog carefully.

Makefile

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@ check_deps := $(foreach dep,$(deps), $(if $(shell which $(dep)),some string,$(er
66
# constants
77
packagename = clams
88
generatedcode = $(packagename)/ver
9-
sdistname = $(packagename)-python
10-
bdistname = $(packagename)_python
9+
distname = $(packagename)_python
1110
artifact = build/lib/$(packagename)
12-
buildcaches = build/bdist* $(bdistname).egg-info __pycache__
11+
buildcaches = build/bdist* $(distname).egg-info __pycache__
1312
testcaches = .hypothesis .pytest_cache .pytype coverage.xml htmlcov .coverage
1413

1514
.PHONY: all
@@ -44,7 +43,7 @@ docs: VERSION $(generatedcode)
4443
pip install --upgrade --no-input "$(mmif)" "$(pydantic)"
4544
rm -rf docs
4645
mkdir -p docs
47-
python3 clams/appmetadata/__init__.py > documentation/appmetadata.jsonschema
46+
python3 -m clams.appmetadata.__init__ > documentation/appmetadata.jsonschema
4847
sphinx-build -a -b html documentation/ docs
4948
mv documentation/appmetadata.jsonschema docs/
5049
touch docs/.nojekyll

docs/.buildinfo

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
2-
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 3b2a5854a2bd9d29779fd7180d2457b7
2+
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 6d67da2a1f4af48ce820f12e90493e11
44
tags: 645f666f9bcd5a90fca523b33c5a78b7
15 Bytes
Binary file not shown.

docs/.doctrees/appmetadata.doctree

23.8 KB
Binary file not shown.
75 KB
Binary file not shown.
792 KB
Binary file not shown.
3.35 KB
Binary file not shown.
45.2 KB
Binary file not shown.

0 commit comments

Comments
 (0)