Skip to content

Commit 9dce4c7

Browse files
Merge pull request SeequentEvo#107 from tim-hamblin-seequent/evo-colormaps
Add ColormapAPIClient
2 parents 22ea4fc + 367d656 commit 9dce4c7

30 files changed

Lines changed: 4369 additions & 1277 deletions

.github/release.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ changelog:
1111
- title: evo-sdk-common
1212
labels:
1313
- evo-sdk-common
14+
- title: evo-colormaps
15+
labels:
16+
- evo-colormaps
1417
- title: evo-files
1518
labels:
1619
- evo-files
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Build and publish evo-colormaps
2+
3+
permissions:
4+
# Required for publishing release artifacts
5+
contents: write
6+
# Required for PyPI trusted publishing
7+
id-token: write
8+
9+
on:
10+
release:
11+
types: [released]
12+
13+
env:
14+
GH_TOKEN: ${{ github.token }}
15+
16+
jobs:
17+
run-tests:
18+
if: startsWith(github.event.release.tag_name, 'evo-colormaps@')
19+
uses: ./.github/workflows/run-all-tests.yaml
20+
21+
build-and-publish:
22+
name: Build and publish package
23+
needs: run-tests
24+
runs-on: ubuntu-latest
25+
steps:
26+
- uses: actions/checkout@v4
27+
28+
- uses: ./.github/actions/install-uv
29+
30+
- name: Build package
31+
shell: bash
32+
run: uv build --package evo-colormaps
33+
34+
- name: Publish to PyPI
35+
uses: pypa/gh-action-pypi-publish@release/v1
36+
37+
- name: Upload artifact to GitHub Release
38+
shell: bash
39+
run: gh release upload ${{ github.event.release.tag_name }} dist/*

.github/workflows/run-all-tests.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ jobs:
2121
- macos-latest
2222
package:
2323
- evo-sdk-common
24+
- evo-colormaps
2425
- evo-files
2526
- evo-objects
2627
python-version:

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,11 @@ test-files:
1515
test-objects:
1616
uv run --package evo-objects pytest packages/evo-objects/tests
1717

18+
test-colormaps:
19+
uv run --package evo-colormaps pytest packages/evo-colormaps/tests
20+
1821
test:
1922
@make test-common
2023
@make test-files
2124
@make test-objects
25+
@make test-colormaps

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ sub-packages and optional dependencies (e.g. Jupyter notebook support), or choos
2525
| [evo-sdk-common](packages/evo-sdk-common/README.md) | <a href="https://pypi.org/project/evo-sdk-common/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/evo-sdk-common" /></a> | A shared library that provides common functionality for integrating with Seequent's client SDKs. |
2626
| [evo-files](packages/evo-files/README.md) | <a href="https://pypi.org/project/evo-files/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/evo-files" /></a> | A service client for interacting with the Evo File API. |
2727
| [evo-objects](packages/evo-objects/README.md) | <a href="https://pypi.org/project/evo-objects/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/evo-objects" /></a> | A geoscience object service client library designed to help get up and running with the Geoscience Object API. |
28+
| [evo-colormaps](packages/evo-colormaps/README.md) | <a href="https://pypi.org/project/evo-colormaps/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/evo-colormaps" /></a> | A service client to create colour mappings and associate them to geoscience data with the Colormap API.|
2829

2930
## Pre-requisites
3031

@@ -80,6 +81,7 @@ For next steps and more information about using Evo, see:
8081
for performing arbitrary Seequent Evo API requests
8182
* [`evo-files`](packages/evo-files/README.md): for interacting with the File API
8283
* [`evo-objects`](packages/evo-objects/README.md): for interacting with the Geoscience Object API
84+
* [`evo-colormaps`](packages/evo-colormaps/README.md): for interacting with the Colormap API
8385
* [Seequent Developer Portal](https://developer.seequent.com/docs/guides/getting-started/quick-start-guide): for guides,
8486
tutorials, and API references
8587

packages/evo-colormaps/LICENSE.md

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
Copyright © 2025 Bentley Systems, Incorporated.
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.
14+
15+
Apache License
16+
Version 2.0, January 2004
17+
http://www.apache.org/licenses/
18+
19+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
20+
21+
1. Definitions.
22+
23+
"License" shall mean the terms and conditions for use, reproduction,
24+
and distribution as defined by Sections 1 through 9 of this document.
25+
26+
"Licensor" shall mean the copyright owner or entity authorized by
27+
the copyright owner that is granting the License.
28+
29+
"Legal Entity" shall mean the union of the acting entity and all
30+
other entities that control, are controlled by, or are under common
31+
control with that entity. For the purposes of this definition,
32+
"control" means (i) the power, direct or indirect, to cause the
33+
direction or management of such entity, whether by contract or
34+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
35+
outstanding shares, or (iii) beneficial ownership of such entity.
36+
37+
"You" (or "Your") shall mean an individual or Legal Entity
38+
exercising permissions granted by this License.
39+
40+
"Source" form shall mean the preferred form for making modifications,
41+
including but not limited to software source code, documentation
42+
source, and configuration files.
43+
44+
"Object" form shall mean any form resulting from mechanical
45+
transformation or translation of a Source form, including but
46+
not limited to compiled object code, generated documentation,
47+
and conversions to other media types.
48+
49+
"Work" shall mean the work of authorship, whether in Source or
50+
Object form, made available under the License, as indicated by a
51+
copyright notice that is included in or attached to the work
52+
(an example is provided in the Appendix below).
53+
54+
"Derivative Works" shall mean any work, whether in Source or Object
55+
form, that is based on (or derived from) the Work and for which the
56+
editorial revisions, annotations, elaborations, or other modifications
57+
represent, as a whole, an original work of authorship. For the purposes
58+
of this License, Derivative Works shall not include works that remain
59+
separable from, or merely link (or bind by name) to the interfaces of,
60+
the Work and Derivative Works thereof.
61+
62+
"Contribution" shall mean any work of authorship, including
63+
the original version of the Work and any modifications or additions
64+
to that Work or Derivative Works thereof, that is intentionally
65+
submitted to Licensor for inclusion in the Work by the copyright owner
66+
or by an individual or Legal Entity authorized to submit on behalf of
67+
the copyright owner. For the purposes of this definition, "submitted"
68+
means any form of electronic, verbal, or written communication sent
69+
to the Licensor or its representatives, including but not limited to
70+
communication on electronic mailing lists, source code control systems,
71+
and issue tracking systems that are managed by, or on behalf of, the
72+
Licensor for the purpose of discussing and improving the Work, but
73+
excluding communication that is conspicuously marked or otherwise
74+
designated in writing by the copyright owner as "Not a Contribution."
75+
76+
"Contributor" shall mean Licensor and any individual or Legal Entity
77+
on behalf of whom a Contribution has been received by Licensor and
78+
subsequently incorporated within the Work.
79+
80+
2. Grant of Copyright License. Subject to the terms and conditions of
81+
this License, each Contributor hereby grants to You a perpetual,
82+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
83+
copyright license to reproduce, prepare Derivative Works of,
84+
publicly display, publicly perform, sublicense, and distribute the
85+
Work and such Derivative Works in Source or Object form.
86+
87+
3. Grant of Patent License. Subject to the terms and conditions of
88+
this License, each Contributor hereby grants to You a perpetual,
89+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
90+
(except as stated in this section) patent license to make, have made,
91+
use, offer to sell, sell, import, and otherwise transfer the Work,
92+
where such license applies only to those patent claims licensable
93+
by such Contributor that are necessarily infringed by their
94+
Contribution(s) alone or by combination of their Contribution(s)
95+
with the Work to which such Contribution(s) was submitted. If You
96+
institute patent litigation against any entity (including a
97+
cross-claim or counterclaim in a lawsuit) alleging that the Work
98+
or a Contribution incorporated within the Work constitutes direct
99+
or contributory patent infringement, then any patent licenses
100+
granted to You under this License for that Work shall terminate
101+
as of the date such litigation is filed.
102+
103+
4. Redistribution. You may reproduce and distribute copies of the
104+
Work or Derivative Works thereof in any medium, with or without
105+
modifications, and in Source or Object form, provided that You
106+
meet the following conditions:
107+
108+
(a) You must give any other recipients of the Work or
109+
Derivative Works a copy of this License; and
110+
111+
(b) You must cause any modified files to carry prominent notices
112+
stating that You changed the files; and
113+
114+
(c) You must retain, in the Source form of any Derivative Works
115+
that You distribute, all copyright, patent, trademark, and
116+
attribution notices from the Source form of the Work,
117+
excluding those notices that do not pertain to any part of
118+
the Derivative Works; and
119+
120+
(d) If the Work includes a "NOTICE" text file as part of its
121+
distribution, then any Derivative Works that You distribute must
122+
include a readable copy of the attribution notices contained
123+
within such NOTICE file, excluding those notices that do not
124+
pertain to any part of the Derivative Works, in at least one
125+
of the following places: within a NOTICE text file distributed
126+
as part of the Derivative Works; within the Source form or
127+
documentation, if provided along with the Derivative Works; or,
128+
within a display generated by the Derivative Works, if and
129+
wherever such third-party notices normally appear. The contents
130+
of the NOTICE file are for informational purposes only and
131+
do not modify the License. You may add Your own attribution
132+
notices within Derivative Works that You distribute, alongside
133+
or as an addendum to the NOTICE text from the Work, provided
134+
that such additional attribution notices cannot be construed
135+
as modifying the License.
136+
137+
You may add Your own copyright statement to Your modifications and
138+
may provide additional or different license terms and conditions
139+
for use, reproduction, or distribution of Your modifications, or
140+
for any such Derivative Works as a whole, provided Your use,
141+
reproduction, and distribution of the Work otherwise complies with
142+
the conditions stated in this License.
143+
144+
5. Submission of Contributions. Unless You explicitly state otherwise,
145+
any Contribution intentionally submitted for inclusion in the Work
146+
by You to the Licensor shall be under the terms and conditions of
147+
this License, without any additional terms or conditions.
148+
Notwithstanding the above, nothing herein shall supersede or modify
149+
the terms of any separate license agreement you may have executed
150+
with Licensor regarding such Contributions.
151+
152+
6. Trademarks. This License does not grant permission to use the trade
153+
names, trademarks, service marks, or product names of the Licensor,
154+
except as required for reasonable and customary use in describing the
155+
origin of the Work and reproducing the content of the NOTICE file.
156+
157+
7. Disclaimer of Warranty. Unless required by applicable law or
158+
agreed to in writing, Licensor provides the Work (and each
159+
Contributor provides its Contributions) on an "AS IS" BASIS,
160+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
161+
implied, including, without limitation, any warranties or conditions
162+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
163+
PARTICULAR PURPOSE. You are solely responsible for determining the
164+
appropriateness of using or redistributing the Work and assume any
165+
risks associated with Your exercise of permissions under this License.
166+
167+
8. Limitation of Liability. In no event and under no legal theory,
168+
whether in tort (including negligence), contract, or otherwise,
169+
unless required by applicable law (such as deliberate and grossly
170+
negligent acts) or agreed to in writing, shall any Contributor be
171+
liable to You for damages, including any direct, indirect, special,
172+
incidental, or consequential damages of any character arising as a
173+
result of this License or out of the use or inability to use the
174+
Work (including but not limited to damages for loss of goodwill,
175+
work stoppage, computer failure or malfunction, or any and all
176+
other commercial damages or losses), even if such Contributor
177+
has been advised of the possibility of such damages.
178+
179+
9. Accepting Warranty or Additional Liability. While redistributing
180+
the Work or Derivative Works thereof, You may choose to offer,
181+
and charge a fee for, acceptance of support, warranty, indemnity,
182+
or other liability obligations and/or rights consistent with this
183+
License. However, in accepting such obligations, You may act only
184+
on Your own behalf and on Your sole responsibility, not on behalf
185+
of any other Contributor, and only if You agree to indemnify,
186+
defend, and hold each Contributor harmless for any liability
187+
incurred by, or claims asserted against, such Contributor by reason
188+
of your accepting any such warranty or additional liability.
189+
190+
END OF TERMS AND CONDITIONS

packages/evo-colormaps/README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<p align="center"><a href="https://seequent.com" target="_blank"><picture><source media="(prefers-color-scheme: dark)" srcset="https://developer.seequent.com/img/seequent-logo-dark.svg" alt="Seequent logo" width="400" /><img src="https://developer.seequent.com/img/seequent-logo.svg" alt="Seequent logo" width="400" /></picture></a></p>
2+
<p align="center">
3+
<a href="https://pypi.org/project/evo-colormaps/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/evo-colormaps" /></a>
4+
<a href="https://github.com/SeequentEvo/evo-python-sdk/actions/workflows/run-all-tests.yaml"><img src="https://github.com/SeequentEvo/evo-python-sdk/actions/workflows/run-all-tests.yaml/badge.svg" alt="" /></a>
5+
</p>
6+
<p align="center">
7+
<a href="https://developer.seequent.com/" target="_blank">Seequent Developer Portal</a>
8+
&bull; <a href="https://community.seequent.com/group/19-evo" target="_blank">Seequent Community</a>
9+
&bull; <a href="https://seequent.com" target="_blank">Seequent website</a>
10+
</p>
11+
12+
# Evo Colormap API Client
13+
14+
The Colormap API is a key feature of the Evo platform, providing a mechanism to create colour mappings and associate them to geoscience data.
15+
16+
## Pre-requisites
17+
18+
* Python ^3.10
19+
* An [application registered in Bentley](https://developer.bentley.com/register/?product=seequent-evo)
20+
21+
## Installation
22+
23+
```shell
24+
pip install evo-colormaps
25+
```
26+
27+
## Usage
28+
29+
To get up and running quickly with the Evo Colormap SDK, start by configuring your
30+
[environment and API connector](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-sdk-common/docs/quickstart.md).
31+
32+
You can then use the `ColormapAPIClient` to perform operations, for example:
33+
34+
```python
35+
from evo.colormaps import ColormapAPIClient
36+
37+
colormap_client = ColormapAPIClient(environment, connector)
38+
colormaps = await colormap_client.list_colormaps()
39+
```
40+
41+
For some interactive Jupyter notebook examples, see the [examples folder](docs/examples).
42+
43+
## Contributing
44+
45+
For instructions on contributing to the development of this library, please refer to the [evo-python-sdk documentation](https://github.com/seequentevo/evo-python-sdk).
46+
47+
## License
48+
49+
The Python SDK for Evo is open source and licensed under the [Apache 2.0 license.](./LICENSE.md).
50+
51+
Copyright © 2025 Bentley Systems, Incorporated.
52+
53+
Licensed under the Apache License, Version 2.0 (the "License").
54+
You may obtain a copy of the License at
55+
56+
http://www.apache.org/licenses/LICENSE-2.0
57+
58+
Unless required by applicable law or agreed to in writing, software
59+
distributed under the License is distributed on an "AS IS" BASIS,
60+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
61+
See the License for the specific language governing permissions and
62+
limitations under the License.
63+

0 commit comments

Comments
 (0)