microsoft / presidio-genproto

Proto files for the presidio project

Proto packages for Presidio API

DEPRECATION NOTICE

This repository is archived, as it is being used by an old Presidio version. To use the latest Presidio version, visit https://www.github.com/microsoft/presidio.

This repository contains the generated GO and Python packages for [Presidio] (https://github.com/microsoft/presidio) API, and the generated gRPC code necessary for interacting with Presidio's gRPC services APIs.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Changing Presidio's API

First, set up a Presidio development environment. For more info, see Presidio's development document (https://github.com/microsoft/presidio/edit/master/docs/development.md)

Presidio leverages protobuf to create API classes and services across multiple environments.

Follow these steps to change Presidio's API:

1. Fork the presidio-genproto repo into YOUR_ORG/presidio-genproto

2. Clone the repo into the $GOPATH/src/github.com/YOUR_ORG/presidio-genproto folder

3. Make the desired changes to the .proto files in /src

4. Install the specific grpcio-tools and protobuf versions

5. Generate the Go and Python files. Run the following commands in the src folder of presidio-genproto:

   python -m grpc_tools.protoc -I . --python_out=../python --grpc_python_out=../python ./*.proto
   
   protoc -I . --go_out=plugins=grpc:../golang ./*.proto

6. Copy all the files in the python folder into presidio-analyzer/analyzer. All generated files end with *pb2.py or *pb2_grpc.py

7. Change the constraint on Gopkg.toml which directs to the location of presidio-genproto From:

[[constraint]]
  branch = "master"
  name = "github.com/Microsoft/presidio-genproto"

To:

[[constraint]]
  branch = "YOUR_GENPROTO_BRANCH"
  name = "github.com/YOUR_ORG/presidio-genproto"

7. Update Gopkg.lock by calling dep ensure or dep ensure --update github.com/YOUR_ORG/presidio-genproto
8. Push all the changes (generated python files, Gopkg.toml and Gopkg.lock into your presidio repo

For more info, see https://grpc.io/docs/tutorials/basic/python.html

presidio-genproto's Issues

Makefile and pipeline are not valid

Protobuf version 3 is now the default, causing the makefile and pipeline to change the protocol in a way which should be validated before it can be merged.

Message names could be improved

Several messages have names in the form Request or Response, e.g. "RecognizersGetResponse", which are counter intuitive in the English language context (should be "GetRecognizersResponse" for example).

We need to consider how to improve these names keeping backwards compatibility with existing code in mind.