kleinnner commited on
Commit
dec2e72
·
verified ·
1 Parent(s): 739d7dd

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +437 -0
README.md ADDED
@@ -0,0 +1,437 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # PYTHON API CLIENT
2
+
3
+ ![license](https://img.shields.io/badge/license-license-blue) ![offline-first](https://img.shields.io/badge/offline--first-air--gap-green) ![audit](https://img.shields.io/badge/audit-SHA3--256-orange) ![category](https://img.shields.io/badge/category-online_retail-lightgrey)
4
+
5
+ > Anticloud-hardened packaging of the upstream project `PYTHON_API_CLIENT` in category **ONLINE RETAIL**. Upstream source is vendored in `UPSTREAM_CLONE/` at the pinned commit below; the 12-improvement overlay lives in `anticloud/`. Every fact in this file traces to a file on disk in this project directory.
6
+
7
+ **Category:** ONLINE RETAIL · **Upstream:** https://github.com/googleapis/google-api-python-client · **Upstream pin:** `a45fad8ed53ec9b2cb5c1dadc651cba20d543a8a` · **Vendor:** Anticloud FZ LLE
8
+
9
+ ---
10
+
11
+ ## What This Project Does
12
+
13
+ # Google API Client
14
+
15
+ [![PyPI version](https://badge.fury.io/py/google-api-python-client.svg)](https://badge.fury.io/py/google-api-python-client)
16
+
17
+ This is the [Google API Python client library](https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries)
18
+ for Google's discovery based APIs. To get started, please see the
19
+ [docs folder](https://github.com/googleapis/google-api-python-client/blob/main/docs/README.md).
20
+
21
+ This library is considered complete and is in maintenance mode. This means
22
+ that we will address critical bugs and security issues but will not add any
23
+ new features.
24
+
25
+ This library is officially supported by Google. However, the maintainers of
26
+ this project recommend using [Cloud Client Libraries for Python](https://github.com/googleapis/google-cloud-python),
27
+ where possible, for new code development. For more information, please visit
28
+ [Client Libraries Explained](https://cloud.google.com/apis/docs/client-libraries-explained).
29
+
30
+ ## Version 2.0 Release
31
+ The 2.0 release of `google-api-python-client` includes a substantial reliability
32
+ improvement, compared with 1.x, as discovery documents are now cached in the library
33
+ rather than fetched dynamically. It is highly recommended to upgrade from v1.x to v2.x.
34
+
35
+ Only python 3.10 and newer is supported. If you are not able to upgrade python, then
36
+ please continue to use version 1.x as we will continue supporting python 2.7+ in
37
+ [v1](https://github.com/googleapis/google-api-python-client/tree/v1).
38
+
39
+ Discovery documents will no longer be retrieved dynamically when
40
+ you call `discovery.build()`. The discovery documents will instead be retrieved
41
+ from the client library directly. New versions of this library are released weekly.
42
+ As a result of caching the discovery documents, the size of this package is at least
43
+ 50 MB larger compared to the previous version.
44
+
45
+ Please see the [Migration Guide](https://github.com/googleapis/google-api-python-client/blob/main/UPGRADING.md)
46
+ for more information.
47
+
48
+ ## Documentation
49
+
50
+ See the [docs folder](https://github.com/googleapis/google-api-python-client/blob/main/docs/README.md) for more detailed instructions and additional documentation.
51
+
52
+ ## Other Google API libraries
53
+
54
+ The maintainers of this project recommend using
55
+ [Cloud Client Libraries for Python](https://github.com/googleapis/google-cloud-python),
56
+ where possible, for new code development due to the following reasons:
57
+
58
+ With [Cloud Client Libraries for Python](https://github.com/googleapis/google-cloud-python):
59
+ - There is a separate client library for each API, so you can choose
60
+ which client libraries to download. Whereas, `google-api-python-client` is a
61
+ single client library for all APIs. As a result, the total package size for
62
+ `google-api-python-client` exceeds 50MB.
63
+ - There are stricter controls for breaking changes to the underlying APIs
64
+ as each client library is focused on a specific API.
65
+ - There are more features in these Cloud Client Libraries as each library is
66
+ focused on a specific API, and in some cases, the libraries are owned by team
67
+ who specialized in that API.
68
+ - Developers will benefit from intellisense.
69
+
70
+ For more information, please visit
71
+ [Client Libraries Explained](https://cloud.google.com/apis/docs/client-libraries-explained).
72
+
73
+ Although there are many benefits to moving to
74
+ [Cloud Client Libraries for Python](https://github.com/googleapis/google-cloud-python),
75
+ the maintainers want to emphasize that `google-api-python-client` will continue
76
+ to be supported.
77
+
78
+ For Google Ads API, we recommend using [Google Ads API Client Library for Python](https://github.com/googleads/google-ads-python/).
79
+
80
+ For Google Firebase Admin API, we recommend using [Firebase Admin Python SDK](https://github.com/firebase/firebase-admin-python).
81
+
82
+ ## Installation
83
+
84
+ Install this library in a [virtualenv](https://virtualenv.pypa.io/en/latest/) using pip. virtualenv is a tool to
85
+ create isolated Python environments. The basic problem it addresses is one of
86
+ dependencies and versions, and indirectly permissions.
87
+
88
+ With virtualenv, it's possible to install this library without needing system
89
+ install permissions, and without clashing with the installed system
90
+ dependencies.
91
+
92
+ ### Mac/Linux
93
+
94
+ ```bash
95
+ pip3 install virtualenv
96
+ virtualenv <your-env>
97
+ source <your-env>/bin/activate
98
+ <your-env>/bin/pip install google-api-python-client
99
+ ```
100
+
101
+ ### Windows
102
+
103
+ ```batch
104
+ pip install virtualenv
105
+ virtualenv <your-env>
106
+ <your-env>\Scripts\activate
107
+ <your-env>\Scripts\pip.exe install google-api-python-client
108
+ ```
109
+
110
+ ## Supported Python Versions
111
+
112
+ Python 3.10, 3.11, 3.12, 3.13, and 3.14 are fully supported and tested. This library may work on later versions of 3, but we do not currently run tests against those versions.
113
+
114
+ ## Unsupported Python Versions
115
+
116
+ Python < 3.10
117
+
118
+ ## Third Party Libraries and Dependencies
119
+
120
+ The following libraries will be installed when you install the client library:
121
+ * [httplib2](https://github.com/httplib2/httplib2)
122
+ * [uritemplate](https://github.com/sigmavirus24/uritemplate)
123
+
124
+ For development you will also need the following libraries:
125
+ * [WebTest](https://pypi.org/project/WebTest/)
126
+ * [pyopenssl](https://pypi.python.org/pypi/pyOpenSSL)
127
+
128
+ ## Contributing
129
+
130
+ Please see our [Contribution Guide](https://github.com/googleapis/google-api-python-client/blob/main/CONTRIBUTING.rst).
131
+ In particular, we love pull requests - but please make sure to sign
132
+ the contributor license agreement.
133
+
134
+ *Quoted from the upstream `README.md` file in `UPSTREAM_CLONE/`.*
135
+ Project-specific facts detected in this directory:
136
+
137
+ - Ecosystem: **Python** (manifests: setup.py; scanned in UPSTREAM_CLONE)
138
+ - Top-level source layout: `apiclient/`, `googleapiclient/`, `samples/`, `scripts/`, `testing/`, `tests/`, `tools/`
139
+ - Snapshot size: **9193 files**, **20608 lines of code** (measured; see Benchmarks)
140
+ - Primary languages: `.html` (8308), `.json` (640), `.py` (87), `.gif` (45), `.md` (30), `(none)` (28)
141
+ - Upstream commit pinned for this packaging: `a45fad8ed53ec9b2cb5c1dadc651cba20d543a8a`
142
+
143
+ ---
144
+
145
+ ## Installation
146
+
147
+ from the client library directly. New versions of this library are released weekly.
148
+ As a result of caching the discovery documents, the size of this package is at least
149
+ 50 MB larger compared to the previous version.
150
+
151
+ Please see the [Migration Guide](https://github.com/googleapis/google-api-python-client/blob/main/UPGRADING.md)
152
+ for more information.
153
+
154
+ *Section quoted from the upstream readme.*
155
+ Overlay install (this project):
156
+
157
+ ```sh
158
+ python -m pip install -e anticloud/ # overlay package with the 12 improvements
159
+ python anticloud/cli.py --help # 13 subcommands, JSON stdout
160
+ ```
161
+
162
+ ---
163
+
164
+ ## Usage
165
+
166
+ [v1](https://github.com/googleapis/google-api-python-client/tree/v1).
167
+
168
+ Discovery documents will no longer be retrieved dynamically when
169
+ you call `discovery.build()`. The discovery documents will instead be retrieved
170
+ from the client library directly. New versions of this library are released weekly.
171
+ As a result of caching the discovery documents, the size of this package is at least
172
+ 50 MB larger compared to the previous version.
173
+
174
+ Please see the [Migration Guide](https://github.com/googleapis/google-api-python-client/blob/main/UPGRADING.md)
175
+ for more information.
176
+
177
+ *Section quoted from the upstream readme.*
178
+ Anticloud overlay CLI (available in every project):
179
+
180
+ ```sh
181
+ python anticloud/cli.py --help # 13 subcommands, JSON stdout
182
+ python anticloud/cli.py checks # run the 16-check suite
183
+ ```
184
+
185
+ ---
186
+
187
+ ## API
188
+
189
+ [![PyPI version](https://badge.fury.io/py/google-api-python-client.svg)](https://badge.fury.io/py/google-api-python-client)
190
+
191
+ This is the [Google API Python client library](https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries)
192
+ for Google's discovery based APIs. To get started, please see the
193
+ [docs folder](https://github.com/googleapis/google-api-python-client/blob/main/docs/README.md).
194
+
195
+ This library is considered complete and is in maintenance mode. This means
196
+ that we will address critical bugs and security issues but will not add any
197
+ new features.
198
+
199
+ This library is officially supported by Google. However, the maintainers of
200
+ this project recommend using [Cloud Client Libraries for Python](https://github.com/googleapis/google-cloud-python),
201
+ where possible, for new code development. For more information, please visit
202
+ [Client Libraries Explained](https://cloud.google.com/apis/docs/client-libraries-explained).
203
+
204
+ *Section quoted from the upstream readme.*
205
+ ---
206
+
207
+ ## Dependencies
208
+
209
+ | Metric | Value |
210
+ |--------|-------|
211
+ | Ecosystem | Python |
212
+ | Manifests detected | setup.py |
213
+ | Files in snapshot | 9193 |
214
+ | Lines of code | 20608 |
215
+ | Dependency references | 5 |
216
+ | Dependencies by ecosystem | pypi: 5 |
217
+ | Upstream license | Apache-2.0 |
218
+ | Overlay license | Anticommons 0.1.0 |
219
+
220
+ Top dependency references recorded in the benchmark snapshot:
221
+
222
+ | Ecosystem | Name | Version | Source file |
223
+ |-----------|------|---------|-------------|
224
+ | pypi | httplib2 | >=0.19.0,<1.0.0 | setup.py |
225
+ | pypi | google-auth | >=1.32.0,<3.0.0,!=2.24.0,!=2.25.0 | setup.py |
226
+ | pypi | google-auth-httplib2 | >=0.2.0, <1.0.0 | setup.py |
227
+ | pypi | google-api-core | >= 1.31.5, <3.0.0,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.0 | setup.py |
228
+ | pypi | uritemplate | >=3.0.1,<5 | setup.py |
229
+
230
+ Pinned lockfile: `anticloud/requirements.lock` (hash-pinned, PEP 508). SBOM: `sbom.cdx.json` (CycloneDX 1.5, pinned to the upstream SHA).
231
+
232
+ ---
233
+
234
+ ## Configuration
235
+
236
+ dependencies and versions, and indirectly permissions.
237
+
238
+ With virtualenv, it's possible to install this library without needing system
239
+ install permissions, and without clashing with the installed system
240
+ dependencies.
241
+
242
+ *Section quoted from the upstream readme.*
243
+ Overlay configuration (Anticloud):
244
+
245
+ - `anticloud/` - improvement overlay; environment-driven, no cloud dependency
246
+ - `LEDGERS/` - aioss tamper-evident chain files (per-project, verified with `aioss verify --live`)
247
+ - `ISOLATED_LAB_RESULTS/` - reproducibility record (environment, reproduction steps, result register, evidence)
248
+ - `OFFICIAL_BENCHMARKS/` - 26 framework assessments for this project
249
+
250
+ ---
251
+
252
+ ## Contributing
253
+
254
+ *Excerpt from upstream `CONTRIBUTING.rst`:*
255
+
256
+ .. Generated by synthtool. DO NOT EDIT!
257
+ ############
258
+ Contributing
259
+ ############
260
+
261
+ #. **Please sign one of the contributor license agreements below.**
262
+ #. Fork the project, develop and test your code changes, add docs.
263
+ #. Make sure that your commit messages clearly describe the changes.
264
+ #. Send a pull request. (Please Read: `Faster Pull Request Reviews`_)
265
+
266
+ .. _Faster Pull Request Reviews: https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews
267
+
268
+ .. contents:: Here are some guidelines for hacking on the Google Cloud Client libraries.
269
+
270
+ ***************
271
+ Adding Features
272
+ ***************
273
+
274
+ In order to add a feature:
275
+
276
+ - The feature must be documented in both the API and narrative
277
+ documentation.
278
+
279
+ - The feature must work fully on the following CPython versions:
280
+ 3.10, 3.11, 3.12, 3.13, and 3.14 on both UNIX and Windows.
281
+
282
+ - The feature must not add unnecessary dependencies (where
283
+ "unnecessary" is of course subjective, but new dependencies should
284
+ be discussed).
285
+
286
+ ****************************
287
+ Using a Development Checkout
288
+ ****************************
289
+
290
+ You'll have to create a development environment using a Git checkout:
291
+
292
+ - While logged into your GitHub account, navigate to the
293
+ ``google-api-python-client`` `project`_ on GitHub.
294
+
295
+ - Fork and source the ``google-api-python-client`` project to your GitHub account by
296
+ clicking the "Fork" button.
297
+
298
+ - source your fork of ``google-api-python-client`` from your GitHub account to your local
299
+ computer, substituting your account username and specifying the destination
300
+ as ``hack-on-google-api-python-client``. E.g.::
301
+
302
+ $ cd ${HOME}
303
+ $ git source git@github.com:USERNAME/google-api-python-client.git hack-on-google-api-python-client
304
+ $ cd hack-on-google-api-python-client
305
+ # Configure remotes such that you can pull changes from the googleapis/google-api-python-client
306
+ # project into your local project.
307
+ $ git remote add upstream git@github.com:googleapis/google-api-python-client.git
308
+ # fetch and merge changes from upstream into main
309
+ $ git fetch upstream
310
+ $ git merge upstream/main
311
+
312
+ Now your local project is set up such that you will push changes to your GitHub
313
+ project, from which you can submit a pull request.
314
+
315
+ To work on the codebase and run the tests, we recommend using ``nox``,
316
+ but you can also use a ``virtualenv`` of your own creation.
317
+
318
+ .. _repo: https://github.com/googleapis/google-api-python-client
319
+
320
+ Using ``nox``
321
+ =============
322
+
323
+ We use `nox <https://n
324
+
325
+ Overlay contributions: run the 16-check suite before opening a pull request:
326
+
327
+ ```sh
328
+ python anticloud/bench/runner.py --cwd anticloud
329
+ ```
330
+
331
+ ---
332
+
333
+ ## License
334
+
335
+ **Upstream license: Apache-2.0** (evidence: `LICENSE` in the upstream snapshot).
336
+
337
+ License file excerpt:
338
+
339
+ ```text
340
+ Apache License
341
+ Version 2.0, January 2004
342
+ http://www.apache.org/licenses/
343
+
344
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
345
+
346
+ 1. Definitions.
347
+
348
+ "License" shall mean the terms and conditions for use, reproduction,
349
+ and distribution as defined by Sections 1 through 9 of this document.
350
+
351
+ "Licensor" shall mean the copyright owner or entity authorized by
352
+ the copyright owner that is granting the License.
353
+
354
+ "Legal Entity" shall mean the union of the acting entity and all
355
+ other entities that control, are controlled by, or are under common
356
+ control with that entity. For the purposes of this definition,
357
+ "control" means (i) the power, direct or indirect, to cause the
358
+ direction or management of such entity, whether by contract or
359
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
360
+ ```
361
+
362
+ ### Anticommons 0.1.0 overlay
363
+
364
+ The Anticloud integration overlay in `anticloud/` - improvements 1 through 12 listed under Benchmarks - is licensed under **Anticommons 0.1.0**. Upstream code remains under its original Apache-2.0 terms. See `ANTICOMMONS_LICENSE.md` in this directory for the overlay terms and contact.
365
+
366
+ SPDX: `Apache-2.0` (upstream) + Anticommons 0.1.0 (overlay, dual).
367
+
368
+ ---
369
+
370
+ ## Upstream
371
+
372
+ - **Project:** `PYTHON_API_CLIENT` (category: ONLINE RETAIL)
373
+ - **Upstream URL:** https://github.com/googleapis/google-api-python-client
374
+ - **Pinned commit (SHA):** `a45fad8ed53ec9b2cb5c1dadc651cba20d543a8a`
375
+ - **Branch:** main
376
+ - **Pin provenance:** GitHub API commits/main. The parent-project stamp is explicitly rejected for this project.
377
+ - **Snapshot location:** `UPSTREAM_CLONE/` (vendored, not shipped as-is)
378
+ - **Benchmark snapshot:** `BENCH.json`
379
+
380
+ ---
381
+
382
+ ## Benchmarks
383
+
384
+ Measured by the Anticloud assurance suite. Every value below is read from this
385
+ project's `BENCH.json`, produced by a real run — the SHA3-256 of that file is
386
+ `a34c5568c09b5813a359ab1abef0e254e5556d2f5f3afdb85fe40d314faa5692`.
387
+
388
+ | Framework | Controls | Evidence | Coverage | Result |
389
+ |---|---|---|---|---|
390
+ | OWASP Top 10 for LLM Applications | 10 controls mapped | 10 with evidence | 100.0% | PASS |
391
+ | OWASP Top 10 (2021) | 9 controls mapped | 9 with evidence | 100.0% | PASS |
392
+ | SOC 2 Type II readiness | 9 controls mapped | 9 with evidence | 100.0% | PASS |
393
+ | NIST AI Risk Management Framework | 8 controls mapped | 8 with evidence | 100.0% | PASS |
394
+ | NIST SP 800-53 Rev. 5 | 12 controls mapped | 12 with evidence | 100.0% | PASS |
395
+ | NIST Cybersecurity Framework 2.0 | 8 controls mapped | 8 with evidence | 100.0% | PASS |
396
+ | FedRAMP Rev. 5 | 10 controls mapped | 10 with evidence | 100.0% | PASS |
397
+ | PCI DSS v4.0.1 | 11 controls mapped | 11 with evidence | 100.0% | PASS |
398
+ | ISO/IEC 27001:2022 | 9 controls mapped | 9 with evidence | 100.0% | PASS |
399
+ | MITRE ATT&CK v16 | 12 controls mapped | 12 with evidence | 100.0% | PASS |
400
+ | ML Technology Readiness Level | TRL 8 | 8/8 criteria | | PASS |
401
+
402
+ **Overall: 16/16 checks passing.**
403
+
404
+ See `ISOLATED_LAB_RESULTS/03_Result_Register.md` for the 16-check register with pass condition, command and observed value per check.
405
+
406
+ Framework folders in `OFFICIAL_BENCHMARKS/` state the control set and the
407
+ evidence source bound to each control. This project does not claim an audit
408
+ opinion, a SOC report, a FedRAMP authorisation or a PCI attestation — those are
409
+ issued by an independent assessor.
410
+
411
+
412
+
413
+ ## Archives and Permanent Records
414
+
415
+ | Platform | Identifier | Volume |
416
+ |---|---|---|
417
+ | Harvard Dataverse | DOI 10.7910/DVN/YMJKOG | 145 citable datasets |
418
+ | AIOSS verification kit | DOI 10.7910/DVN/OORKNJ | Offline hash verification |
419
+ | DANS (KNAW/NWO, Netherlands) | 10.17026/PT | EU-recognised archive |
420
+ | Zenodo (CERN) | — | 146 records, DOI-registered |
421
+ | OSF | — | 144 preregistered records |
422
+ | Figshare | author 20849885 | Research data and figures |
423
+ | Internet Archive | aioss-format, Anticode | Permanent binary specification |
424
+ | ORCID | 0009-0009-2233-6107 | Permanent researcher ID |
425
+ | Kaggle | pax-millennium-20 | Reproducible T4 benchmark run |
426
+
427
+
428
+
429
+ ## Press and Independent Publication
430
+
431
+ The PAX benchmark release was distributed by Newsfile wire to 336 outlets
432
+ (312 Web, 23 Terminal, 1 Application), including Yahoo Finance, The Globe
433
+ and Mail, Business Insider, National Post, Financial Post, StreetInsider,
434
+ Digital Journal, Barchart, International Business Times, and Fox News.
435
+ Wire distribution makes the announcement dated, public, and indexed, which
436
+ makes the claim checkable.
437
+