summaryrefslogtreecommitdiff
path: root/python-terrasnek.spec
blob: 941892fc080c2b2df207550fe8767c411059b8b9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
%global _empty_manifest_terminate_build 0
Name:		python-terrasnek
Version:	0.1.12
Release:	1
Summary:	A Python client for the Terraform Cloud API
License:	Mozilla Public License 2.0 (MPL 2.0)
URL:		https://github.com/dahlke/terrasnek
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/be/e0/ca073c520fb97e4f6387a14580efdf370d2227eb4a109fb8a15e9ba11ba1/terrasnek-0.1.12.tar.gz
BuildArch:	noarch

Requires:	python3-requests

%description
![terrasnek logo](/img/tsnk1_md.png)
## Overview
The goal of this project is to support all endpoints available in the
[Terraform Cloud API](https://developer.hashicorp.com/terraform/cloud-docs/api-docs)
and [Terraform Enterprise](https://www.terraform.io/docs/enterprise/index.html) API.
In general, `terrasnek` is developed against the Terraform Cloud APIs first (as
most features are released there first and may not be available in Terraform
Enterprise), but all endpoints are loved equally and this project intends to
support both types of users.
_Note: This project is tested against Terraform Enterprise often, but the code coverage
represented in this repo will always represent coverage against Terraform Cloud
Business Tier (skipping all `admin` modules), so the coverage percentage
is higher than represented in the badge._
**[Terraform Enterprise Release Notes](https://github.com/hashicorp/terraform-enterprise-release-notes)**
**[Terraform Cloud API Changelog](https://www.terraform.io/docs/cloud/api/changelog.html)**
_Note: Terraform Enterprise is the self-hosted distribution of Terraform Cloud.
It offers enterprises a private instance of the Terraform Cloud application,
with no resource limits and with additional enterprise-grade architectural
features like audit logging and SAML single sign-on._
### Using `terrasnek`
For more details on using each endpoint, check out the
[docs](https://terrasnek.readthedocs.io/en/latest/) or the [`test`](./test)
directory.
```python3
from terrasnek.api import TFC
import os
TFC_TOKEN = os.getenv("TFC_TOKEN", None)
TFC_URL = os.getenv("TFC_URL", None)  # ex: https://app.terraform.io
# set to True if you want to use HTTP or insecure HTTPS
SSL_VERIFY = os.getenv("SSL_VERIFY", False)
if __name__ == "__main__":
    api = TFC(TFC_TOKEN, url=TFC_URL, verify=SSL_VERIFY)
    api.set_org("YOUR_ORGANIZATION")
```
### `terrasnek` to Terraform Cloud API Spec Completeness
To compare `terrasnek` implemented endpoints to those listed on the Terraform
 Cloud API docs, view the auto-generated
[`TERRASNEK_API_COVERAGE_COMPLETENESS.md`](TERRASNEK_API_COVERAGE_COMPLETENESS.md)
file. The goal is to always have over 95% of all published endpoints implemented
at any time.
### `terrasnek` Common Use Case Examples
See the [`terrasnek` docs](https://terrasnek.readthedocs.io/en/latest/). You
can download the docs as a PDF directly from `readthedocs.io`.
### Contributing to `terrasnek`
If you'd like to contribute to `terrasnek`, review [`CONTRIBUTING.md`](CONTRIBUTING.md).
### Relevant Blogs
- [Migrating a Lot of State with Python and the Terraform Cloud API](https://medium.com/hashicorp-engineering/migrating-a-lot-of-state-with-python-and-the-terraform-cloud-api-997ec798cd11)

%package -n python3-terrasnek
Summary:	A Python client for the Terraform Cloud API
Provides:	python-terrasnek
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-terrasnek
![terrasnek logo](/img/tsnk1_md.png)
## Overview
The goal of this project is to support all endpoints available in the
[Terraform Cloud API](https://developer.hashicorp.com/terraform/cloud-docs/api-docs)
and [Terraform Enterprise](https://www.terraform.io/docs/enterprise/index.html) API.
In general, `terrasnek` is developed against the Terraform Cloud APIs first (as
most features are released there first and may not be available in Terraform
Enterprise), but all endpoints are loved equally and this project intends to
support both types of users.
_Note: This project is tested against Terraform Enterprise often, but the code coverage
represented in this repo will always represent coverage against Terraform Cloud
Business Tier (skipping all `admin` modules), so the coverage percentage
is higher than represented in the badge._
**[Terraform Enterprise Release Notes](https://github.com/hashicorp/terraform-enterprise-release-notes)**
**[Terraform Cloud API Changelog](https://www.terraform.io/docs/cloud/api/changelog.html)**
_Note: Terraform Enterprise is the self-hosted distribution of Terraform Cloud.
It offers enterprises a private instance of the Terraform Cloud application,
with no resource limits and with additional enterprise-grade architectural
features like audit logging and SAML single sign-on._
### Using `terrasnek`
For more details on using each endpoint, check out the
[docs](https://terrasnek.readthedocs.io/en/latest/) or the [`test`](./test)
directory.
```python3
from terrasnek.api import TFC
import os
TFC_TOKEN = os.getenv("TFC_TOKEN", None)
TFC_URL = os.getenv("TFC_URL", None)  # ex: https://app.terraform.io
# set to True if you want to use HTTP or insecure HTTPS
SSL_VERIFY = os.getenv("SSL_VERIFY", False)
if __name__ == "__main__":
    api = TFC(TFC_TOKEN, url=TFC_URL, verify=SSL_VERIFY)
    api.set_org("YOUR_ORGANIZATION")
```
### `terrasnek` to Terraform Cloud API Spec Completeness
To compare `terrasnek` implemented endpoints to those listed on the Terraform
 Cloud API docs, view the auto-generated
[`TERRASNEK_API_COVERAGE_COMPLETENESS.md`](TERRASNEK_API_COVERAGE_COMPLETENESS.md)
file. The goal is to always have over 95% of all published endpoints implemented
at any time.
### `terrasnek` Common Use Case Examples
See the [`terrasnek` docs](https://terrasnek.readthedocs.io/en/latest/). You
can download the docs as a PDF directly from `readthedocs.io`.
### Contributing to `terrasnek`
If you'd like to contribute to `terrasnek`, review [`CONTRIBUTING.md`](CONTRIBUTING.md).
### Relevant Blogs
- [Migrating a Lot of State with Python and the Terraform Cloud API](https://medium.com/hashicorp-engineering/migrating-a-lot-of-state-with-python-and-the-terraform-cloud-api-997ec798cd11)

%package help
Summary:	Development documents and examples for terrasnek
Provides:	python3-terrasnek-doc
%description help
![terrasnek logo](/img/tsnk1_md.png)
## Overview
The goal of this project is to support all endpoints available in the
[Terraform Cloud API](https://developer.hashicorp.com/terraform/cloud-docs/api-docs)
and [Terraform Enterprise](https://www.terraform.io/docs/enterprise/index.html) API.
In general, `terrasnek` is developed against the Terraform Cloud APIs first (as
most features are released there first and may not be available in Terraform
Enterprise), but all endpoints are loved equally and this project intends to
support both types of users.
_Note: This project is tested against Terraform Enterprise often, but the code coverage
represented in this repo will always represent coverage against Terraform Cloud
Business Tier (skipping all `admin` modules), so the coverage percentage
is higher than represented in the badge._
**[Terraform Enterprise Release Notes](https://github.com/hashicorp/terraform-enterprise-release-notes)**
**[Terraform Cloud API Changelog](https://www.terraform.io/docs/cloud/api/changelog.html)**
_Note: Terraform Enterprise is the self-hosted distribution of Terraform Cloud.
It offers enterprises a private instance of the Terraform Cloud application,
with no resource limits and with additional enterprise-grade architectural
features like audit logging and SAML single sign-on._
### Using `terrasnek`
For more details on using each endpoint, check out the
[docs](https://terrasnek.readthedocs.io/en/latest/) or the [`test`](./test)
directory.
```python3
from terrasnek.api import TFC
import os
TFC_TOKEN = os.getenv("TFC_TOKEN", None)
TFC_URL = os.getenv("TFC_URL", None)  # ex: https://app.terraform.io
# set to True if you want to use HTTP or insecure HTTPS
SSL_VERIFY = os.getenv("SSL_VERIFY", False)
if __name__ == "__main__":
    api = TFC(TFC_TOKEN, url=TFC_URL, verify=SSL_VERIFY)
    api.set_org("YOUR_ORGANIZATION")
```
### `terrasnek` to Terraform Cloud API Spec Completeness
To compare `terrasnek` implemented endpoints to those listed on the Terraform
 Cloud API docs, view the auto-generated
[`TERRASNEK_API_COVERAGE_COMPLETENESS.md`](TERRASNEK_API_COVERAGE_COMPLETENESS.md)
file. The goal is to always have over 95% of all published endpoints implemented
at any time.
### `terrasnek` Common Use Case Examples
See the [`terrasnek` docs](https://terrasnek.readthedocs.io/en/latest/). You
can download the docs as a PDF directly from `readthedocs.io`.
### Contributing to `terrasnek`
If you'd like to contribute to `terrasnek`, review [`CONTRIBUTING.md`](CONTRIBUTING.md).
### Relevant Blogs
- [Migrating a Lot of State with Python and the Terraform Cloud API](https://medium.com/hashicorp-engineering/migrating-a-lot-of-state-with-python-and-the-terraform-cloud-api-997ec798cd11)

%prep
%autosetup -n terrasnek-0.1.12

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-terrasnek -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 0.1.12-1
- Package Spec generated