Metadata-Version: 2.4
Name: cybergoatz-terraform-client
Version: 1.0.0
Summary: CyberGoatz platform Terraform orchestration client
Project-URL: GitHub, https://github.com/CyberGoatz/backend-terraform-client
Project-URL: Upstream, https://github.com/cyberrangecz/backend-terraform-client
Author: cybersecurityhub.cz
Author-email: Chainscore Labs <hello@chainscore.finance>
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.9
Requires-Dist: crczp-aws-lib~=1.0.1
Requires-Dist: crczp-openstack-lib~=1.0.0
Requires-Dist: crczp-python-commons~=1.0.1
Requires-Dist: cybergoatz-azure-lib>=1.0.1
Requires-Dist: jinja2>=3.1.6
Description-Content-Type: text/markdown

# cybergoatz-terraform-client

Terraform orchestration client for CyberGoatz Platform sandbox provisioning.

This package is a CyberGoatz-maintained fork of CyberRangeCZ's
`backend-terraform-client`. It keeps the existing `crczp.terraform_driver`
Python import namespace for compatibility with the CRCZP/CyberRangeCZ backend
ecosystem, while publishing the fork under the separate
`cybergoatz-terraform-client` distribution name.

## Installation

```bash
pip install cybergoatz-terraform-client
```

## Usage

```python
from crczp.terraform_driver import CrczpTerraformClient
```

The client coordinates Terraform/OpenTofu sandbox provisioning across the
supported cloud drivers:

- OpenStack through `crczp-openstack-lib`
- AWS through `crczp-aws-lib`
- Azure through `cybergoatz-azure-lib`

## Package contents

- `crczp/terraform_driver` -- Terraform client implementation
- `crczp/terraform_driver/templates` -- Terraform backend template assets
- `pyproject.toml` -- package metadata and build configuration
- `.github/workflows/publish.yml` -- PyPI release workflow

## Releasing

The package version is read from `pyproject.toml`.

To publish a release:

1. Update `project.version` in `pyproject.toml`.
2. Commit the change.
3. Create and push a matching tag, for example `v1.0.2`.
4. The `Publish to PyPI` GitHub Actions workflow builds the source
   distribution and wheel, validates them with Twine, and publishes via PyPI
   trusted publishing.

## Attribution

This project is derived from CyberRangeCZ's `backend-terraform-client` package.
The original work is credited to Masaryk University and CyberSecurity Hub,
z.s.; their copyright and MIT license notices are retained.

CyberGoatz-specific changes are maintained by Chainscore Labs.
