Skip to content

Commit

Permalink
#58 change g2 to sz
Browse files Browse the repository at this point in the history
  • Loading branch information
docktermj committed Apr 10, 2024
1 parent 6675efc commit bc4c7b6
Show file tree
Hide file tree
Showing 9 changed files with 35 additions and 36 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/go-proxy-pull.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ jobs:
- name: pull new module version
uses: andrewslotin/go-proxy-pull-action@v1.1.0
with:
import_path: github.com/senzing-garage/g2-sdk-proto
import_path: github.com/senzing-garage/sz-sdk-proto
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ The variables are used throughout the installation procedure.

```console
export GIT_ACCOUNT=senzing
export GIT_REPOSITORY=g2-sdk-proto
export GIT_REPOSITORY=sz-sdk-proto
```

Synthesize environment variables.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# g2-sdk-proto
# sz-sdk-proto

If you are beginning your journey with
[Senzing](https://senzing.com/),
Expand Down Expand Up @@ -44,7 +44,7 @@ for use in servers and clients of the Senzing engine.

1. [Development](docs/development.md)
1. [Errors](docs/errors.md)
1. [Package reference](https://pkg.go.dev/github.com/senzing-garage/g2-sdk-proto/go)
1. [Package reference](https://pkg.go.dev/github.com/senzing-garage/sz-sdk-proto/go)
1. [Protocol Buffers Overview](https://developers.google.com/protocol-buffers/docs/overview)
1. [Language Guide for proto3](https://developers.google.com/protocol-buffers/docs/proto3)
1. [Protocol buffers](https://developers.google.com/protocol-buffers)
Expand Down
4 changes: 2 additions & 2 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# g2-sdk-proto development
# sz-sdk-proto development

## Prerequisites

Expand All @@ -10,7 +10,7 @@

```console
export GIT_ACCOUNT=senzing-garage
export GIT_REPOSITORY=g2-sdk-proto
export GIT_REPOSITORY=sz-sdk-proto
export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git
export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}"

Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/senzing-garage/g2-sdk-proto
module github.com/senzing-garage/sz-sdk-proto

go 1.21

Expand Down
40 changes: 20 additions & 20 deletions go/README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,53 @@
# g2-sdk-proto/go
# sz-sdk-proto/go

## :warning: WARNING: g2-sdk-proto/go is still in development :warning: _
## :warning: WARNING: sz-sdk-proto/go is still in development :warning: _

At the moment, this is "work-in-progress" with Semantic Versions of `0.n.x`.
Although it can be reviewed and commented on,
the recommendation is not to use it yet.

## Synopsis

The Senzing g2-sdk-proto/go packages provide code generated by
The Senzing sz-sdk-proto/go packages provide code generated by
[protoc](https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/protoc.md)
for use in creating Senzing gRPC clients and servers.

[![Go Reference](https://pkg.go.dev/badge/github.com/senzing-garage/g2-sdk-proto/go.svg)](https://pkg.go.dev/github.com/senzing-garage/g2-sdk-proto/go)
[![Go Report Card](https://goreportcard.com/badge/github.com/senzing-garage/g2-sdk-proto/go)](https://goreportcard.com/report/github.com/senzing-garage/g2-sdk-proto/go)
[![Go Reference](https://pkg.go.dev/badge/github.com/senzing-garage/sz2-sdk-proto/go.svg)](https://pkg.go.dev/github.com/senzing-garage/sz-sdk-proto/go)
[![Go Report Card](https://goreportcard.com/badge/github.com/senzing-garage/sz-sdk-proto/go)](https://goreportcard.com/report/github.com/senzing-garage/sz-sdk-proto/go)

## Overview

1. Import the Senzing `g2-sdk-proto/go` packages.
1. Import the Senzing `sz-sdk-proto/go` packages.
Example:

```go
import (
"github.com/senzing-garage/g2-sdk-proto/go/g2config"
"github.com/senzing-garage/g2-sdk-proto/go/g2configmgr"
"github.com/senzing-garage/g2-sdk-proto/go/g2diagnostic"
"github.com/senzing-garage/g2-sdk-proto/go/g2engine"
"github.com/senzing-garage/g2-sdk-proto/go/g2product"
"github.com/senzing-garage/sz-sdk-proto/go/szconfig"
"github.com/senzing-garage/sz-sdk-proto/go/szconfigmanager"
"github.com/senzing-garage/sz-sdk-proto/go/szdiagnostic"
"github.com/senzing-garage/sz-sdk-proto/go/szengine"
"github.com/senzing-garage/sz-sdk-proto/go/szproduct"
)
```

1. Examples of use:
1. Used in [server](https://github.com/senzing-garage/serve-grpc/blob/main/g2engineserver/g2engineserver.go)
1. Used in [client](https://github.com/senzing-garage/g2-sdk-go-grpc/blob/main/g2engineclient/g2engineclient.go)
1. Used in [server](https://github.com/senzing-garage/serve-grpc/blob/main/szengineserver/szengineserver.go)
1. Used in [client](https://github.com/senzing-garage/sz-sdk-go-grpc/blob/main/szengineclient/szengineclient.go)

## Development

This section describes how the packages are generated.
For package use, see above.

The Senzing g2-sdk-proto/go packages are generated by the
The Senzing sz-sdk-proto/go packages are generated by the
[protoc](https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/protoc.md)
command.

1. Set these environment variable values identifying the Git repository:

```console
export GIT_ACCOUNT=senzing
export GIT_REPOSITORY=g2-sdk-proto
export GIT_REPOSITORY=sz-sdk-proto
export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git
export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}"
Expand All @@ -58,11 +58,11 @@ command.

```console
export SENZING_COMPONENTS=( \
"g2config" \
"g2configmgr" \
"g2diagnostic" \
"g2engine" \
"g2product" \
"szconfig" \
"szconfigmgr" \
"szdiagnostic" \
"szengine" \
"szproduct" \
)
```
Expand Down
3 changes: 1 addition & 2 deletions python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Auto-generated python protobuf source for calling Senzing through grpc
## Overview

The git repository at
[github.com/senzing-garage/senzing-ce-grpc-protobuf](https://github.com/senzing-garage/g2-sdk-proto)
[github.com/senzing-garage/sz-sdk-proto](https://github.com/senzing-garage/sz-sdk-proto)
contains the .proto files and generated code for many languages

It also contains:
Expand Down Expand Up @@ -37,4 +37,3 @@ It also contains:
```console
pip install dist/senzing_grpc_protobuf-0.0.3-py3-none-any.whl
```

10 changes: 5 additions & 5 deletions python/create_package.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
import tempfile

proto_files = [
"g2configmgr.proto",
"g2config.proto",
"g2diagnostic.proto",
"g2engine.proto",
"g2product.proto",
"szconfigmgr.proto",
"szconfig.proto",
"szdiagnostic.proto",
"szengine.proto",
"szproduct.proto",
]

package_name = "senzing_grpc_protobuf"
Expand Down
4 changes: 2 additions & 2 deletions python/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ classifiers = [
]

[project.urls]
"Homepage" = "https://github.com/senzing-garage/g2-sdk-proto"
"Bug Tracker" = "https://github.com/senzing-garage/g2-sdk-proto/issues"
"Homepage" = "https://github.com/senzing-garage/sz-sdk-proto"
"Bug Tracker" = "https://github.com/senzing-garage/sz-sdk-proto/issues"

0 comments on commit bc4c7b6

Please sign in to comment.