Metadata-Version: 2.4
Name: surfaces-client
Version: 0.1.1
Summary: Python client for Surfaces and OpenWorks ISets (Interpretation Sets) APIs developed by SDD-SID
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: azure-identity>=1.25
Requires-Dist: dotenv>=0.9
Requires-Dist: pandas<3,>=2.3
Requires-Dist: requests>=2.32
Dynamic: license-file

# Surfaces Client

Python client for Surfaces and OpenWorks ISets (Interpretation Sets) APIs developed by SDD-SID.

## Commits

This repository follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for semantic commit messages and pull request titles. This means commit messages and pull request titles must be structured as:

```plaintext
<type>[optional scope]: <description>
```

Common types include `feat` (feature), `fix` (bug fix), `docs` (documentation), `refactor` (code refactoring) and `ci` (continuous integration). Using a `!` after the type or including `BREAKING CHANGE:` in the commit message footer or pull request description signals a breaking change.

Examples:

- `feat: add support for 3D surfaces`
- `fix: handle empty response from ISets API`
- `feat!: rename surfaces endpoint`

## Release

Releases are automated using [Release Please](https://github.com/googleapis/release-please). It parses the Conventional Commits history to determine the next version number and generates a changelog automatically:

- `feat` commits trigger a **minor** version bump
- `fix` and other commits trigger a **patch** version bump
- Breaking changes trigger a **major** version bump

Release Please opens a pull request with the proposed version and changelog. Merging that pull request creates the release and publishes it to PyPI.

## Versioning

This repository follows the [Semantic Versioning](https://semver.org/) specification for release tags.
