mergetbapi 0.0.1__tar.gz

mergetbapi-0.0.1/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2024 USC INFORMATION SCIENCES INSTITUTE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mergetbapi-0.0.1/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.1
+Name: mergetbapi
+Version: 0.0.1
+Summary: Python bindings for the GRPC client interface to the MergeTB API
+Author-email: Brian Kocoloski <bkocolos@isi.edu>
+Project-URL: Homepage, https://gitlab.com/mergetb/api
+Project-URL: Issues, https://gitlab.com/mergetb/api/-/issues
+Project-URL: Documentation, https://mergetb.gitlab.io/api/
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: betterproto==2.0.0b6
+Requires-Dist: grpclib==0.4.7
+
+# mergetb_api
+
+This package contains Python bindings for the GRPC client interface to MergeTB API
+

mergetbapi-0.0.1/README.md

@@ -0,0 +1,4 @@
+# mergetb_api
+
+This package contains Python bindings for the GRPC client interface to MergeTB API
+

mergetbapi-0.0.1/pyproject.toml

@@ -0,0 +1,26 @@
+[project]
+name = "mergetbapi"
+version = "0.0.1"
+authors = [
+    { name="Brian Kocoloski", email="bkocolos@isi.edu" },
+]
+description = "Python bindings for the GRPC client interface to the MergeTB API"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Intended Audience :: End Users/Desktop",
+    "Development Status :: 4 - Beta",
+]
+dependencies = [
+    "betterproto==2.0.0b6",
+    "grpclib==0.4.7",
+]
+
+[project.urls]
+Homepage = "https://gitlab.com/mergetb/api"
+Issues = "https://gitlab.com/mergetb/api/-/issues"
+Documentation = "https://mergetb.gitlab.io/api/"

mergetbapi-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mergetbapi-0.0.1/src/google/api/__init__.py

@@ -0,0 +1,255 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# sources: google/api/annotations.proto, google/api/field_behavior.proto, google/api/http.proto
+# plugin: python-betterproto
+# This file has been @generated
+
+from dataclasses import dataclass
+from typing import List
+
+import betterproto
+
+
+class FieldBehavior(betterproto.Enum):
+    """
+    An indicator of the behavior of a given field (for example, that a field is
+    required in requests, or given as output but ignored as input). This **does
+    not** change the behavior in protocol buffers itself; it only denotes the
+    behavior and may affect how API tooling handles the field. Note: This enum
+    **may** receive new values in the future.
+    """
+
+    FIELD_BEHAVIOR_UNSPECIFIED = 0
+    """Conventional default for enums. Do not use this."""
+
+    OPTIONAL = 1
+    """
+    Specifically denotes a field as optional. While all fields in protocol
+    buffers are optional, this may be specified for emphasis if appropriate.
+    """
+
+    REQUIRED = 2
+    """
+    Denotes a field as required. This indicates that the field **must** be
+    provided as part of the request, and failure to do so will cause an error
+    (usually `INVALID_ARGUMENT`).
+    """
+
+    OUTPUT_ONLY = 3
+    """
+    Denotes a field as output only. This indicates that the field is provided
+    in responses, but including the field in a request does nothing (the server
+    *must* ignore it and *must not* throw an error as a result of the field's
+    presence).
+    """
+
+    INPUT_ONLY = 4
+    """
+    Denotes a field as input only. This indicates that the field is provided in
+    requests, and the corresponding field is not included in output.
+    """
+
+    IMMUTABLE = 5
+    """
+    Denotes a field as immutable. This indicates that the field may be set once
+    in a request to create a resource, but may not be changed thereafter.
+    """
+
+
+@dataclass(eq=False, repr=False)
+class Http(betterproto.Message):
+    """
+    Defines the HTTP configuration for an API service. It contains a list of
+    [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC
+    method to one or more HTTP REST API methods.
+    """
+
+    rules: List["HttpRule"] = betterproto.message_field(1)
+    """
+    A list of HTTP configuration rules that apply to individual API methods.
+    **NOTE:** All service configuration rules follow "last one wins" order.
+    """
+
+    fully_decode_reserved_expansion: bool = betterproto.bool_field(2)
+    """
+    When set to true, URL path parmeters will be fully URI-decoded except in
+    cases of single segment matches in reserved expansion, where "%2F" will be
+    left encoded. The default behavior is to not decode RFC 6570 reserved
+    characters in multi segment matches.
+    """
+
+
+@dataclass(eq=False, repr=False)
+class HttpRule(betterproto.Message):
+    """
+    `HttpRule` defines the mapping of an RPC method to one or more HTTP REST
+    API methods. The mapping specifies how different portions of the RPC
+    request message are mapped to URL path, URL query parameters, and HTTP
+    request body. The mapping is typically specified as an `google.api.http`
+    annotation on the RPC method, see "google/api/annotations.proto" for
+    details. The mapping consists of a field specifying the path template and
+    method kind.  The path template can refer to fields in the request message,
+    as in the example below which describes a REST GET operation on a resource
+    collection of messages:     service Messaging {       rpc
+    GetMessage(GetMessageRequest) returns (Message) {         option
+    (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}";       }
+    }     message GetMessageRequest {       message SubMessage {         string
+    subfield = 1;       }       string message_id = 1; // mapped to the URL
+    SubMessage sub = 2;    // `sub.subfield` is url-mapped     }     message
+    Message {       string text = 1; // content of the resource     } The same
+    http annotation can alternatively be expressed inside the `GRPC API
+    Configuration` YAML file.     http:       rules:         - selector:
+    <proto_package_name>.Messaging.GetMessage           get:
+    /v1/messages/{message_id}/{sub.subfield} This definition enables an
+    automatic, bidrectional mapping of HTTP JSON to RPC. Example: HTTP | RPC
+    -----|----- `GET /v1/messages/123456/foo`  | `GetMessage(message_id:
+    "123456" sub: SubMessage(subfield: "foo"))` In general, not only fields but
+    also field paths can be referenced from a path pattern. Fields mapped to
+    the path pattern cannot be repeated and must have a primitive (non-message)
+    type. Any fields in the request message which are not bound by the path
+    pattern automatically become (optional) HTTP query parameters. Assume the
+    following definition of the request message:     service Messaging {
+    rpc GetMessage(GetMessageRequest) returns (Message) {         option
+    (google.api.http).get = "/v1/messages/{message_id}";       }     }
+    message GetMessageRequest {       message SubMessage {         string
+    subfield = 1;       }       string message_id = 1; // mapped to the URL
+    int64 revision = 2;    // becomes a parameter       SubMessage sub = 3;
+    // `sub.subfield` becomes a parameter     } This enables a HTTP JSON to RPC
+    mapping as below: HTTP | RPC -----|----- `GET
+    /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id:
+    "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields
+    which are mapped to HTTP parameters must have a primitive type or a
+    repeated primitive type. Message types are not allowed. In the case of a
+    repeated type, the parameter can be repeated in the URL, as in
+    `...?param=A&param=B`. For HTTP method kinds which allow a request body,
+    the `body` field specifies the mapping. Consider a REST update method on
+    the message resource collection:     service Messaging {       rpc
+    UpdateMessage(UpdateMessageRequest) returns (Message) {         option
+    (google.api.http) = {           put: "/v1/messages/{message_id}"
+    body: "message"         };       }     }     message UpdateMessageRequest {
+    string message_id = 1; // mapped to the URL       Message message = 2;   //
+    mapped to the body     } The following HTTP JSON to RPC mapping is enabled,
+    where the representation of the JSON in the request body is determined by
+    protos JSON encoding: HTTP | RPC -----|----- `PUT /v1/messages/123456 {
+    "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text:
+    "Hi!" })` The special name `*` can be used in the body mapping to define
+    that every field not bound by the path template should be mapped to the
+    request body.  This enables the following alternative definition of the
+    update method:     service Messaging {       rpc UpdateMessage(Message)
+    returns (Message) {         option (google.api.http) = {           put:
+    "/v1/messages/{message_id}"           body: "*"         };       }     }
+    message Message {       string message_id = 1;       string text = 2;     }
+    The following HTTP JSON to RPC mapping is enabled: HTTP | RPC -----|-----
+    `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
+    "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is
+    not possible to have HTTP parameters, as all fields not bound by the path
+    end in the body. This makes this option more rarely used in practice of
+    defining REST APIs. The common usage of `*` is in custom methods which
+    don't use the URL at all for transferring data. It is possible to define
+    multiple HTTP methods for one RPC by using the `additional_bindings`
+    option. Example:     service Messaging {       rpc
+    GetMessage(GetMessageRequest) returns (Message) {         option
+    (google.api.http) = {           get: "/v1/messages/{message_id}"
+    additional_bindings {             get:
+    "/v1/users/{user_id}/messages/{message_id}"           }         };       }
+    }     message GetMessageRequest {       string message_id = 1;       string
+    user_id = 2;     } This enables the following two alternative HTTP JSON to
+    RPC mappings: HTTP | RPC -----|----- `GET /v1/messages/123456` |
+    `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` |
+    `GetMessage(user_id: "me" message_id: "123456")` # Rules for HTTP mapping
+    The rules for mapping HTTP path, query parameters, and body fields to the
+    request message are as follows: 1. The `body` field specifies either `*` or
+    a field path, or is    omitted. If omitted, it indicates there is no HTTP
+    request body. 2. Leaf fields (recursive expansion of nested messages in the
+    request) can be classified into three types:     (a) Matched in the URL
+    template.     (b) Covered by body (if body is `*`, everything except (a)
+    fields;         else everything under the body field)     (c) All other
+    fields. 3. URL query parameters found in the HTTP request are mapped to (c)
+    fields. 4. Any body sent with an HTTP request can contain only (b) fields.
+    The syntax of the path template is as follows:     Template = "/" Segments
+    [ Verb ] ;     Segments = Segment { "/" Segment } ;     Segment  = "*" |
+    "**" | LITERAL | Variable ;     Variable = "{" FieldPath [ "=" Segments ]
+    "}" ;     FieldPath = IDENT { "." IDENT } ;     Verb     = ":" LITERAL ;
+    The syntax `*` matches a single path segment. The syntax `**` matches zero
+    or more path segments, which must be the last part of the path except the
+    `Verb`. The syntax `LITERAL` matches literal text in the path. The syntax
+    `Variable` matches part of the URL path as specified by its template. A
+    variable template must not contain other variables. If a variable matches a
+    single path segment, its template may be omitted, e.g. `{var}` is
+    equivalent to `{var=*}`. If a variable contains exactly one path segment,
+    such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a
+    URL path, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. Such
+    variables show up in the Discovery Document as `{var}`. If a variable
+    contains one or more path segments, such as `"{var=foo/*}"` or
+    `"{var=**}"`, when such a variable is expanded into a URL path, all
+    characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables
+    show up in the Discovery Document as `{+var}`. NOTE: While the single
+    segment variable matches the semantics of [RFC
+    6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
+    Expansion, the multi segment variable **does not** match RFC 6570 Reserved
+    Expansion. The reason is that the Reserved Expansion does not expand
+    special characters like `?` and `#`, which would lead to invalid URLs.
+    NOTE: the field paths in variables and in the `body` must not refer to
+    repeated fields or map fields.
+    """
+
+    selector: str = betterproto.string_field(1)
+    """
+    Selects methods to which this rule applies. Refer to
+    [selector][google.api.DocumentationRule.selector] for syntax details.
+    """
+
+    get: str = betterproto.string_field(2, group="pattern")
+    """Used for listing and getting information about resources."""
+
+    put: str = betterproto.string_field(3, group="pattern")
+    """Used for updating a resource."""
+
+    post: str = betterproto.string_field(4, group="pattern")
+    """Used for creating a resource."""
+
+    delete: str = betterproto.string_field(5, group="pattern")
+    """Used for deleting a resource."""
+
+    patch: str = betterproto.string_field(6, group="pattern")
+    """Used for updating a resource."""
+
+    custom: "CustomHttpPattern" = betterproto.message_field(8, group="pattern")
+    """
+    The custom pattern is used for specifying an HTTP method that is not
+    included in the `pattern` field, such as HEAD, or "*" to leave the HTTP
+    method unspecified for this rule. The wild-card rule is useful for services
+    that provide content to Web (HTML) clients.
+    """
+
+    body: str = betterproto.string_field(7)
+    """
+    The name of the request field whose value is mapped to the HTTP body, or
+    `*` for mapping all fields not captured by the path pattern to the HTTP
+    body. NOTE: the referred field must not be a repeated field and must be
+    present at the top-level of request message type.
+    """
+
+    response_body: str = betterproto.string_field(12)
+    """
+    Optional. The name of the response field whose value is mapped to the HTTP
+    body of response. Other response fields are ignored. When not set, the
+    response message will be used as HTTP body of response.
+    """
+
+    additional_bindings: List["HttpRule"] = betterproto.message_field(11)
+    """
+    Additional HTTP bindings for the selector. Nested bindings must not contain
+    an `additional_bindings` field themselves (that is, the nesting may only be
+    one level deep).
+    """
+
+
+@dataclass(eq=False, repr=False)
+class CustomHttpPattern(betterproto.Message):
+    """A custom pattern is used for defining custom HTTP verb."""
+
+    kind: str = betterproto.string_field(1)
+    """The name of this custom HTTP verb."""
+
+    path: str = betterproto.string_field(2)
+    """The path matched by this custom verb."""