Skip to content

Commit 164e09a

Browse files
authored
Merge pull request #94 from verda-cloud/feature/update-licence-to-apache-2
Update LICENSE to Apache 2.0
2 parents 0831b8f + f1f3ae2 commit 164e09a

94 files changed

Lines changed: 1633 additions & 21 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.

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212
- `LongTermService` with `get_cluster_periods()` and `get_instance_periods()` methods
1313
- `VolumesService.delete_by_id()` method using `DELETE /v1/volumes/{volume_id}` endpoint
1414
- Support for querying OS images by instance type via `verda.images.get(instance_type=...)`
15+
- Apache 2.0 license headers to all source files
1516

1617
### Changed
1718

1819
- Refactored `Image` model to use `@dataclass` and `@dataclass_json` for consistency with `Instance` and `Volume`
20+
- License changed from MIT to Apache 2.0
1921

2022
## [1.24.0] - 2026-03-30
2123

CLAUDE.md

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
# CLAUDE.md
2+
3+
## Project overview
4+
5+
Official Python SDK for the Verda Cloud API (formerly DataCrunch). The main package is `verda`, with a backward-compatible `datacrunch_compat` wrapper that re-exports everything under the old `datacrunch` name.
6+
7+
- **Package name:** `verda` (PyPI)
8+
- **Python:** >= 3.10, tested on 3.10 through 3.14
9+
- **License:** Apache 2.0
10+
- **Build system:** `uv_build`
11+
12+
## Common commands
13+
14+
```bash
15+
uv sync # install dependencies
16+
uv run pytest # run all tests (unit + integration)
17+
uv run pytest tests/unit_tests # run unit tests only
18+
uv run ruff check # lint
19+
uv run ruff format --check # check formatting
20+
uv run ruff format # auto-format
21+
```
22+
23+
CI runs three checks on every PR: unit tests (Python 3.10-3.14), `ruff check`, and `ruff format --check`.
24+
25+
## Project structure
26+
27+
```
28+
verda/ # main SDK source
29+
_verda.py # VerdaClient entry point
30+
_version.py # version string
31+
constants.py # shared constants and enums
32+
exceptions.py # APIException
33+
helpers.py # utility functions
34+
http_client/ # HTTP wrapper with auth token refresh
35+
authentication/ # OAuth2 token management
36+
instances/ # instance lifecycle (create, delete, hibernate, etc.)
37+
volumes/ # storage volume management
38+
containers/ # serverless container deployments
39+
job_deployments/ # serverless batch jobs
40+
clusters/ # compute clusters
41+
images/ # OS images
42+
locations/ # datacenter locations
43+
ssh_keys/ # SSH key management
44+
startup_scripts/ # startup scripts
45+
balance/ # account balance
46+
inference_client/ # inference request handling
47+
instance_types/ # available instance types
48+
volume_types/ # available volume types
49+
cluster_types/ # available cluster types
50+
container_types/ # available container types
51+
datacrunch_compat/ # backward-compat wrapper (deprecated)
52+
tests/
53+
unit_tests/ # pytest unit tests, organized by module
54+
integration_tests/ # integration tests hitting real API
55+
examples/ # usage examples
56+
docs/ # Sphinx documentation
57+
.github/workflows/ # CI/CD (tests, lint, format, publish)
58+
```
59+
60+
## Module conventions
61+
62+
Each service module follows this pattern:
63+
64+
```
65+
verda/<service>/
66+
__init__.py # public exports only (no license header)
67+
_<service>.py # all implementation: dataclasses, service class, endpoint constant
68+
```
69+
70+
- The `__init__.py` only re-exports public symbols from the private `_<service>.py` module.
71+
- `__init__.py` files do NOT have the Apache 2.0 license header. All other `.py` files do.
72+
- Implementation files are prefixed with `_` (e.g., `_instances.py`, `_volumes.py`).
73+
74+
## Code style
75+
76+
### Formatting and linting
77+
78+
- **Tool:** Ruff (lint + format)
79+
- **Line length:** 100 characters
80+
- **Quote style:** single quotes
81+
- **Docstring convention:** Google style
82+
- **Import sorting:** handled by ruff (`I` rules)
83+
84+
### Ruff rules enabled
85+
86+
`E4, E7, E9, F, C4, I, PT, B, UP, D, A, ARG, RUF`
87+
88+
Key rule groups: default pyflakes/pycodestyle, comprehensions, import sorting, pytest conventions, bugbear, Python syntax upgrades, pydocstyle (Google), builtins shadowing, unused args, ruff-specific.
89+
90+
Ignored: `F401` (unused imports), `B006` (mutable default args), `D100` (module docstring), `D105` (magic method docstring), `D107` (`__init__` docstring).
91+
92+
Per-file ignores:
93+
94+
- `tests/`, `examples/`, `datacrunch_compat/tests/` -- all `D` rules (docstrings not required)
95+
- `__init__.py` -- `D104` (missing package docstring)
96+
- `datacrunch_compat/datacrunch/*.py` -- `F403` (wildcard imports allowed)
97+
98+
### Type hints
99+
100+
- Use Python 3.10+ union syntax: `str | None` (not `Optional[str]`)
101+
- Type-annotate function signatures and return types
102+
- Use `Literal` for constrained string values (e.g., `Contract = Literal['LONG_TERM', 'PAY_AS_YOU_GO', 'SPOT']`)
103+
104+
### Dataclasses
105+
106+
- Use `@dataclass_json` decorator from `dataclasses_json` for JSON serialization
107+
- Use `@dataclass_json(undefined=Undefined.EXCLUDE)` for API response models (tolerates extra fields)
108+
- Stack decorators: `@dataclass_json` first, then `@dataclass`
109+
- Optional fields use `field(default=None)` or `= None`
110+
- Google-style docstrings with `Attributes:` section
111+
112+
### License header
113+
114+
All `.py` files (except `__init__.py`) must have this header at the top:
115+
116+
```python
117+
# Copyright 2026 Verda Cloud Oy
118+
#
119+
# Licensed under the Apache License, Version 2.0 (the "License");
120+
# you may not use this file except in compliance with the License.
121+
# You may obtain a copy of the License at
122+
#
123+
# http://www.apache.org/licenses/LICENSE-2.0
124+
#
125+
# Unless required by applicable law or agreed to in writing, software
126+
# distributed under the License is distributed on an "AS IS" BASIS,
127+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
128+
# See the License for the specific language governing permissions and
129+
# limitations under the License.
130+
```
131+
132+
Ensure two blank lines between the header and the first top-level `class`/`def` (ruff enforces this).
133+
134+
## Testing conventions
135+
136+
- **Framework:** pytest
137+
- **HTTP mocking:** `responses` library (via `pytest-responses`)
138+
- **Test organization:** class-based, one test class per service (e.g., `TestVolumesService`)
139+
- **Fixture pattern:** shared `http_client` fixture in `conftest.py` using `unittest.mock.Mock` for auth
140+
- **Per-test fixtures:** `<service>_service` and `endpoint` fixtures defined inside each test class
141+
- **Naming:** `test_<action>_<successful|failed>` (e.g., `test_create_volume_successful`, `test_create_volume_failed`)
142+
- **Structure:** arrange/act/assert pattern with `# arrange`, `# act`, `# assert` comments
143+
- **API error tests:** use `pytest.raises(APIException)` and verify `.code` and `.message`
144+
- **Request matching:** use `responses.add()` with `matchers.json_params_matcher()` to verify request payloads
145+
- **Test data:** define constants and mock payloads as module-level variables at top of test file
146+
147+
## Git and branching
148+
149+
- **Main branch:** `master`
150+
- **Branch naming:** `feature/<name>` for features, `fix/<name>` for bugfixes
151+
- **PRs:** tests must pass on all supported Python versions before merge
152+
153+
## Release process
154+
155+
1. `uv version --bump minor` (or `major`/`patch`)
156+
2. Update `CHANGELOG.md`
157+
3. Commit, tag with `v<version>`, push to `master` with tags
158+
4. Publish via GitHub release (triggers PyPI publish workflow)
159+
160+
## Dependencies
161+
162+
- **Runtime:** `requests` (HTTP), `dataclasses_json` (serialization)
163+
- **Dev:** `pytest`, `pytest-cov`, `pytest-responses`, `responses`, `python-dotenv`, `ruff`
164+
165+
* IMPORTANT: Never jump directly to the conclusion. First think about constraints and considerations before answering. This applies to all questions including ones that look simple, practical, obvious or straightforward. Labeling a question as not needing analysis is itself a failure mode.

LICENSE

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

0 commit comments

Comments
 (0)