Python stubs generated from gRPC protobuf definitions for Apex Nova services.


License
MIT
Install
pip install apexnova-stubs==1.2.87

Documentation

ApexNova Protobuf Definitions and Stubs

Overview

This repository contains the Protocol Buffer (.proto) definitions used by ApexNova services, as well as the generated stub files for easy integration into your projects. These definitions are crucial for generating client and server code used for gRPC communication between services.

Repository Structure

The repository is organized as follows:

proto/
    |── service1/
    β”‚    └── service1.proto
    |
    |── service2/
    β”‚    └── service2.proto
    |
    └── stub/
         └── stub_types.proto

stubs/
    |── service1/
    β”‚    └── service1_stub/
    |
    └── service2/
         └── service2_stub/
  • service1/, service2/: Directories containing .proto files specific to a service and the corresponding generated stub files. The stub files are ready for integration into service-specific implementations.
  • stub/: Directory containing .proto files for stub types used across different services.

Usage

To use these .proto files and stub files in your project, you can either clone this repository or reference it directly if your build system supports remote dependencies.

Cloning the Repository

To clone the repository, execute:

git clone https://github.com/apexnova-vc/proto.git

This will create a local copy of the repository, allowing you to explore and integrate the .proto and stub files as needed.

Using Remote Files

If your build system supports it, you can directly reference the .proto files and stub files in this repository. For example, in a Gradle project, you might use the following dependencies:

dependencies {
    implementation 'com.apexnova:proto:<version>'
    implementation 'com.apexnova:stub:<version>'
}

Be sure to replace <version> with the specific version you want to use.

Generating Stub Files

The stub files in this repository are generated from the .proto files using Gradle. Here’s a general outline of the process:

  1. Clone the Proto repository.
  2. Use Gradle to build the project, which will generate the stub files in the stubs/ directory.
  3. Integrate the generated stub files into your service implementations.

Example for building the project:

./gradlew build

Contribution

Contributions to this repository are welcome. Please ensure that any changes to the .proto files are backward compatible to avoid breaking changes in services that depend on these definitions.