frequenz-api-common 0.0.1__tar.gz → 0.2.0__tar.gz

{frequenz-api-common-0.0.1 → frequenz-api-common-0.2.0}/CONTRIBUTING.md

@@ -1,5 +1,5 @@
-Contributing to Frequenz Microgrid API
-======================================
+Contributing to Frequenz Common API
+===================================
 
 
 Build
@@ -64,11 +64,11 @@ These are the steps to create a new release:
 
 5. A GitHub action will test the tag and if all goes well it will create
    a [GitHub
-   Release](https://github.com/frequenz-floss/frequenz-api-microgrid/releases),
+   Release](https://github.com/frequenz-floss/frequenz-api-common/releases),
    create a new
-   [announcement](https://github.com/frequenz-floss/frequenz-api-microgrid/discussions/categories/announcements)
+   [announcement](https://github.com/frequenz-floss/frequenz-api-common/discussions/categories/announcements)
    about the release, and upload a new package to
-   [PyPI](https://pypi.org/project/frequenz-api-microgrid/) automatically.
+   [PyPI](https://pypi.org/project/frequenz-api-common/) automatically.
 
 6. Once this is done, reset the `RELEASE_NOTES.md` with the template:
 

{frequenz-api-common-0.0.1 → frequenz-api-common-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: frequenz-api-common
-Version: 0.0.1
+Version: 0.2.0
 Summary: Frequenz common gRPC API and bindings
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT

frequenz-api-common-0.2.0/RELEASE_NOTES.md

@@ -0,0 +1,6 @@
+# Frequenz Common API Release Notes
+
+## Summary
+
+- Various build system fixes
+- Improved smoothness of using this as a dependency

{frequenz-api-common-0.0.1 → frequenz-api-common-0.2.0}/py/frequenz_api_common.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: frequenz-api-common
-Version: 0.0.1
+Version: 0.2.0
 Summary: Frequenz common gRPC API and bindings
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT

frequenz-api-common-0.2.0/py/frequenz_api_common.egg-info/SOURCES.txt

@@ -0,0 +1,73 @@
+CODEOWNERS
+CONTRIBUTING.md
+LICENSE
+MANIFEST.in
+README.md
+RELEASE_NOTES.md
+pyproject.toml
+proto/frequenz/api/common/components.proto
+proto/frequenz/api/common/metrics.proto
+proto/frequenz/api/common/metrics/electrical.proto
+py/frequenz/api/common/__init__.py
+py/frequenz/api/common/py.typed
+py/frequenz/api/common/metrics/__init__.py
+py/frequenz_api_common.egg-info/PKG-INFO
+py/frequenz_api_common.egg-info/SOURCES.txt
+py/frequenz_api_common.egg-info/dependency_links.txt
+py/frequenz_api_common.egg-info/requires.txt
+py/frequenz_api_common.egg-info/top_level.txt
+submodules/api-common-protos/google/api/annotations.proto
+submodules/api-common-protos/google/api/auth.proto
+submodules/api-common-protos/google/api/backend.proto
+submodules/api-common-protos/google/api/billing.proto
+submodules/api-common-protos/google/api/client.proto
+submodules/api-common-protos/google/api/config_change.proto
+submodules/api-common-protos/google/api/consumer.proto
+submodules/api-common-protos/google/api/context.proto
+submodules/api-common-protos/google/api/control.proto
+submodules/api-common-protos/google/api/distribution.proto
+submodules/api-common-protos/google/api/documentation.proto
+submodules/api-common-protos/google/api/endpoint.proto
+submodules/api-common-protos/google/api/field_behavior.proto
+submodules/api-common-protos/google/api/http.proto
+submodules/api-common-protos/google/api/httpbody.proto
+submodules/api-common-protos/google/api/label.proto
+submodules/api-common-protos/google/api/launch_stage.proto
+submodules/api-common-protos/google/api/log.proto
+submodules/api-common-protos/google/api/logging.proto
+submodules/api-common-protos/google/api/metric.proto
+submodules/api-common-protos/google/api/monitored_resource.proto
+submodules/api-common-protos/google/api/monitoring.proto
+submodules/api-common-protos/google/api/quota.proto
+submodules/api-common-protos/google/api/resource.proto
+submodules/api-common-protos/google/api/routing.proto
+submodules/api-common-protos/google/api/service.proto
+submodules/api-common-protos/google/api/source_info.proto
+submodules/api-common-protos/google/api/system_parameter.proto
+submodules/api-common-protos/google/api/usage.proto
+submodules/api-common-protos/google/cloud/extended_operations.proto
+submodules/api-common-protos/google/iam/admin/v1/iam.proto
+submodules/api-common-protos/google/iam/v1/iam_policy.proto
+submodules/api-common-protos/google/iam/v1/options.proto
+submodules/api-common-protos/google/iam/v1/policy.proto
+submodules/api-common-protos/google/iam/v1/logging/audit_data.proto
+submodules/api-common-protos/google/logging/type/http_request.proto
+submodules/api-common-protos/google/logging/type/log_severity.proto
+submodules/api-common-protos/google/longrunning/operations.proto
+submodules/api-common-protos/google/rpc/code.proto
+submodules/api-common-protos/google/rpc/error_details.proto
+submodules/api-common-protos/google/rpc/status.proto
+submodules/api-common-protos/google/rpc/context/attribute_context.proto
+submodules/api-common-protos/google/type/calendar_period.proto
+submodules/api-common-protos/google/type/color.proto
+submodules/api-common-protos/google/type/date.proto
+submodules/api-common-protos/google/type/datetime.proto
+submodules/api-common-protos/google/type/dayofweek.proto
+submodules/api-common-protos/google/type/expr.proto
+submodules/api-common-protos/google/type/fraction.proto
+submodules/api-common-protos/google/type/latlng.proto
+submodules/api-common-protos/google/type/money.proto
+submodules/api-common-protos/google/type/month.proto
+submodules/api-common-protos/google/type/postal_address.proto
+submodules/api-common-protos/google/type/quaternion.proto
+submodules/api-common-protos/google/type/timeofday.proto

{frequenz-api-common-0.0.1 → frequenz-api-common-0.2.0}/py/frequenz_api_common.egg-info/requires.txt

@@ -13,16 +13,16 @@ black==23.3.0
 isort==5.12.0
 
 [dev-mypy]
-mypy==1.1.1
+mypy==1.3.0
 frequenz-api-common[dev-noxfile,dev-pytest]
 
 [dev-noxfile]
-nox==2022.11.21
+nox==2023.4.22
 frequenz-repo-config[api]==0.1.0
 
 [dev-pylint]
-pylint==2.17.1
+pylint==2.17.4
 frequenz-api-common[dev-noxfile,dev-pytest]
 
 [dev-pytest]
-pytest==7.2.2
+pytest==7.3.1

{frequenz-api-common-0.0.1 → frequenz-api-common-0.2.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [build-system]
 requires = [
-  "setuptools >= 67.3.2, < 68",
-  "setuptools_scm[toml] >= 7.1.0, < 8",
+  "setuptools == 67.7.2",
+  "setuptools_scm[toml] == 7.1.0",
   "frequenz-repo-config[api] == 0.1.0",
 ]
 build-backend = "setuptools.build_meta"
@@ -35,17 +35,17 @@ email = "floss@frequenz.com"
 dev-docstrings = ["pydocstyle == 6.3.0", "darglint == 1.8.1"]
 dev-formatting = ["black == 23.3.0", "isort == 5.12.0"]
 dev-mypy = [
-  "mypy == 1.1.1",
+  "mypy == 1.3.0",
   # For checking the noxfile and tests
   "frequenz-api-common[dev-noxfile,dev-pytest]",
 ]
-dev-noxfile = ["nox == 2022.11.21", "frequenz-repo-config[api] == 0.1.0"]
+dev-noxfile = ["nox == 2023.4.22", "frequenz-repo-config[api] == 0.1.0"]
 dev-pylint = [
-  "pylint == 2.17.1",
+  "pylint == 2.17.4",
   # For checking the noxfile and tests
   "frequenz-api-common[dev-noxfile,dev-pytest]",
 ]
-dev-pytest = ["pytest == 7.2.2"]
+dev-pytest = ["pytest == 7.3.1"]
 dev = [
   "frequenz-api-common[dev-docstrings,dev-formatting,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
 ]

frequenz-api-common-0.2.0/submodules/api-common-protos/google/api/annotations.proto

@@ -0,0 +1,31 @@
+// Copyright (c) 2015, Google Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.api;
+
+import "google/api/http.proto";
+import "google/protobuf/descriptor.proto";
+
+option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
+option java_multiple_files = true;
+option java_outer_classname = "AnnotationsProto";
+option java_package = "com.google.api";
+option objc_class_prefix = "GAPI";
+
+extend google.protobuf.MethodOptions {
+  // See `HttpRule`.
+  HttpRule http = 72295728;
+}

frequenz-api-common-0.2.0/submodules/api-common-protos/google/api/auth.proto

@@ -0,0 +1,181 @@
+// Copyright 2018 Google LLC.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.api;
+
+import "google/api/annotations.proto";
+
+option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
+option java_multiple_files = true;
+option java_outer_classname = "AuthProto";
+option java_package = "com.google.api";
+option objc_class_prefix = "GAPI";
+
+
+// `Authentication` defines the authentication configuration for an API.
+//
+// Example for an API targeted for external use:
+//
+//     name: calendar.googleapis.com
+//     authentication:
+//       providers:
+//       - id: google_calendar_auth
+//         jwks_uri: https://www.googleapis.com/oauth2/v1/certs
+//         issuer: https://securetoken.google.com
+//       rules:
+//       - selector: "*"
+//         requirements:
+//           provider_id: google_calendar_auth
+message Authentication {
+  // A list of authentication rules that apply to individual API methods.
+  //
+  // **NOTE:** All service configuration rules follow "last one wins" order.
+  repeated AuthenticationRule rules = 3;
+
+  // Defines a set of authentication providers that a service supports.
+  repeated AuthProvider providers = 4;
+}
+
+// Authentication rules for the service.
+//
+// By default, if a method has any authentication requirements, every request
+// must include a valid credential matching one of the requirements.
+// It's an error to include more than one kind of credential in a single
+// request.
+//
+// If a method doesn't have any auth requirements, request credentials will be
+// ignored.
+message AuthenticationRule {
+  // Selects the methods to which this rule applies.
+  //
+  // Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
+  string selector = 1;
+
+  // The requirements for OAuth credentials.
+  OAuthRequirements oauth = 2;
+
+  // If true, the service accepts API keys without any other credential.
+  bool allow_without_credential = 5;
+
+  // Requirements for additional authentication providers.
+  repeated AuthRequirement requirements = 7;
+}
+
+// Configuration for an anthentication provider, including support for
+// [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
+message AuthProvider {
+  // The unique identifier of the auth provider. It will be referred to by
+  // `AuthRequirement.provider_id`.
+  //
+  // Example: "bookstore_auth".
+  string id = 1;
+
+  // Identifies the principal that issued the JWT. See
+  // https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
+  // Usually a URL or an email address.
+  //
+  // Example: https://securetoken.google.com
+  // Example: 1234567-compute@developer.gserviceaccount.com
+  string issuer = 2;
+
+  // URL of the provider's public key set to validate signature of the JWT. See
+  // [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
+  // Optional if the key set document:
+  //  - can be retrieved from
+  //    [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
+  //    of the issuer.
+  //  - can be inferred from the email domain of the issuer (e.g. a Google service account).
+  //
+  // Example: https://www.googleapis.com/oauth2/v1/certs
+  string jwks_uri = 3;
+
+  // The list of JWT
+  // [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
+  // that are allowed to access. A JWT containing any of these audiences will
+  // be accepted. When this setting is absent, only JWTs with audience
+  // "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
+  // will be accepted. For example, if no audiences are in the setting,
+  // LibraryService API will only accept JWTs with the following audience
+  // "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
+  //
+  // Example:
+  //
+  //     audiences: bookstore_android.apps.googleusercontent.com,
+  //                bookstore_web.apps.googleusercontent.com
+  string audiences = 4;
+
+  // Redirect URL if JWT token is required but no present or is expired.
+  // Implement authorizationUrl of securityDefinitions in OpenAPI spec.
+  string authorization_url = 5;
+}
+
+// OAuth scopes are a way to define data and permissions on data. For example,
+// there are scopes defined for "Read-only access to Google Calendar" and
+// "Access to Cloud Platform". Users can consent to a scope for an application,
+// giving it permission to access that data on their behalf.
+//
+// OAuth scope specifications should be fairly coarse grained; a user will need
+// to see and understand the text description of what your scope means.
+//
+// In most cases: use one or at most two OAuth scopes for an entire family of
+// products. If your product has multiple APIs, you should probably be sharing
+// the OAuth scope across all of those APIs.
+//
+// When you need finer grained OAuth consent screens: talk with your product
+// management about how developers will use them in practice.
+//
+// Please note that even though each of the canonical scopes is enough for a
+// request to be accepted and passed to the backend, a request can still fail
+// due to the backend requiring additional scopes or permissions.
+message OAuthRequirements {
+  // The list of publicly documented OAuth scopes that are allowed access. An
+  // OAuth token containing any of these scopes will be accepted.
+  //
+  // Example:
+  //
+  //      canonical_scopes: https://www.googleapis.com/auth/calendar,
+  //                        https://www.googleapis.com/auth/calendar.read
+  string canonical_scopes = 1;
+}
+
+// User-defined authentication requirements, including support for
+// [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
+message AuthRequirement {
+  // [id][google.api.AuthProvider.id] from authentication provider.
+  //
+  // Example:
+  //
+  //     provider_id: bookstore_auth
+  string provider_id = 1;
+
+  // NOTE: This will be deprecated soon, once AuthProvider.audiences is
+  // implemented and accepted in all the runtime components.
+  //
+  // The list of JWT
+  // [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
+  // that are allowed to access. A JWT containing any of these audiences will
+  // be accepted. When this setting is absent, only JWTs with audience
+  // "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
+  // will be accepted. For example, if no audiences are in the setting,
+  // LibraryService API will only accept JWTs with the following audience
+  // "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
+  //
+  // Example:
+  //
+  //     audiences: bookstore_android.apps.googleusercontent.com,
+  //                bookstore_web.apps.googleusercontent.com
+  string audiences = 2;
+}

frequenz-api-common-0.2.0/submodules/api-common-protos/google/api/backend.proto

@@ -0,0 +1,51 @@
+// Copyright 2018 Google LLC.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.api;
+
+option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
+option java_multiple_files = true;
+option java_outer_classname = "BackendProto";
+option java_package = "com.google.api";
+option objc_class_prefix = "GAPI";
+
+
+// `Backend` defines the backend configuration for a service.
+message Backend {
+  // A list of API backend rules that apply to individual API methods.
+  //
+  // **NOTE:** All service configuration rules follow "last one wins" order.
+  repeated BackendRule rules = 1;
+}
+
+// A backend rule provides configuration for an individual API element.
+message BackendRule {
+  // Selects the methods to which this rule applies.
+  //
+  // Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
+  string selector = 1;
+
+  // The address of the API backend.
+  string address = 2;
+
+  // The number of seconds to wait for a response from a request.  The default
+  // deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.
+  double deadline = 3;
+
+  // Minimum deadline in seconds needed for this method. Calls having deadline
+  // value lower than this will be rejected.
+  double min_deadline = 4;
+}

frequenz-api-common-0.2.0/submodules/api-common-protos/google/api/billing.proto

@@ -0,0 +1,67 @@
+// Copyright 2018 Google LLC.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.api;
+
+import "google/api/annotations.proto";
+
+option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
+option java_multiple_files = true;
+option java_outer_classname = "BillingProto";
+option java_package = "com.google.api";
+option objc_class_prefix = "GAPI";
+
+
+// Billing related configuration of the service.
+//
+// The following example shows how to configure monitored resources and metrics
+// for billing:
+//
+//     monitored_resources:
+//     - type: library.googleapis.com/branch
+//       labels:
+//       - key: /city
+//         description: The city where the library branch is located in.
+//       - key: /name
+//         description: The name of the branch.
+//     metrics:
+//     - name: library.googleapis.com/book/borrowed_count
+//       metric_kind: DELTA
+//       value_type: INT64
+//     billing:
+//       consumer_destinations:
+//       - monitored_resource: library.googleapis.com/branch
+//         metrics:
+//         - library.googleapis.com/book/borrowed_count
+message Billing {
+  // Configuration of a specific billing destination (Currently only support
+  // bill against consumer project).
+  message BillingDestination {
+    // The monitored resource type. The type must be defined in
+    // [Service.monitored_resources][google.api.Service.monitored_resources] section.
+    string monitored_resource = 1;
+
+    // Names of the metrics to report to this billing destination.
+    // Each name must be defined in [Service.metrics][google.api.Service.metrics] section.
+    repeated string metrics = 2;
+  }
+
+  // Billing configurations for sending metrics to the consumer project.
+  // There can be multiple consumer destinations per service, each one must have
+  // a different monitored resource type. A metric can be used in at most
+  // one consumer destination.
+  repeated BillingDestination consumer_destinations = 8;
+}

frequenz-api-common-0.2.0/submodules/api-common-protos/google/api/client.proto

@@ -0,0 +1,99 @@
+// Copyright 2020 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.api;
+
+import "google/protobuf/descriptor.proto";
+
+option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
+option java_multiple_files = true;
+option java_outer_classname = "ClientProto";
+option java_package = "com.google.api";
+option objc_class_prefix = "GAPI";
+
+extend google.protobuf.MethodOptions {
+  // A definition of a client library method signature.
+  //
+  // In client libraries, each proto RPC corresponds to one or more methods
+  // which the end user is able to call, and calls the underlying RPC.
+  // Normally, this method receives a single argument (a struct or instance
+  // corresponding to the RPC request object). Defining this field will
+  // add one or more overloads providing flattened or simpler method signatures
+  // in some languages.
+  //
+  // The fields on the method signature are provided as a comma-separated
+  // string.
+  //
+  // For example, the proto RPC and annotation:
+  //
+  //   rpc CreateSubscription(CreateSubscriptionRequest)
+  //       returns (Subscription) {
+  //     option (google.api.method_signature) = "name,topic";
+  //   }
+  //
+  // Would add the following Java overload (in addition to the method accepting
+  // the request object):
+  //
+  //   public final Subscription createSubscription(String name, String topic)
+  //
+  // The following backwards-compatibility guidelines apply:
+  //
+  //   * Adding this annotation to an unannotated method is backwards
+  //     compatible.
+  //   * Adding this annotation to a method which already has existing
+  //     method signature annotations is backwards compatible if and only if
+  //     the new method signature annotation is last in the sequence.
+  //   * Modifying or removing an existing method signature annotation is
+  //     a breaking change.
+  //   * Re-ordering existing method signature annotations is a breaking
+  //     change.
+  repeated string method_signature = 1051;
+}
+
+extend google.protobuf.ServiceOptions {
+  // The hostname for this service.
+  // This should be specified with no prefix or protocol.
+  //
+  // Example:
+  //
+  //   service Foo {
+  //     option (google.api.default_host) = "foo.googleapi.com";
+  //     ...
+  //   }
+  string default_host = 1049;
+
+  // OAuth scopes needed for the client.
+  //
+  // Example:
+  //
+  //   service Foo {
+  //     option (google.api.oauth_scopes) = \
+  //       "https://www.googleapis.com/auth/cloud-platform";
+  //     ...
+  //   }
+  //
+  // If there is more than one scope, use a comma-separated string:
+  //
+  // Example:
+  //
+  //   service Foo {
+  //     option (google.api.oauth_scopes) = \
+  //       "https://www.googleapis.com/auth/cloud-platform,"
+  //       "https://www.googleapis.com/auth/monitoring";
+  //     ...
+  //   }
+  string oauth_scopes = 1050;
+}