Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/helsing-ai/buffrs
Modern protobuf package management
https://github.com/helsing-ai/buffrs
distribution package-manager protobuf protocol-buffers registry
Last synced: about 1 month ago
JSON representation
Modern protobuf package management
- Host: GitHub
- URL: https://github.com/helsing-ai/buffrs
- Owner: helsing-ai
- License: apache-2.0
- Created: 2023-06-13T15:43:56.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-04-26T14:50:59.000Z (about 1 month ago)
- Last Synced: 2024-04-27T15:40:44.424Z (about 1 month ago)
- Topics: distribution, package-manager, protobuf, protocol-buffers, registry
- Language: Rust
- Homepage: https://crates.io/crates/buffrs
- Size: 1.94 MB
- Stars: 135
- Watchers: 14
- Forks: 10
- Open Issues: 58
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Lists
- awesome-rust - helsing-ai/buffrs
- awesome-grpc - buffrs
README
# Buffrs
**Modern protobuf package management**
[](https://helsing.ai)
[](https://crates.io/crates/buffrs)
[](https://helsing-ai.github.io/buffrs)
[](https://docs.rs/buffrs)
## Quickstart
```bash,ignore
$ cargo install buffrs
$ buffrs login
$ buffrs init --api
$ buffrs add
$ buffrs install
```
Useful resources:
- [The Buffrs Book](https://helsing-ai.github.io/buffrs)
- [Crate Documentation](https://docs.rs/buffrs)
- [Announcement Post](https://blog.helsing.ai/buffrs-a-package-manager-for-protocol-buffers-1-2-aaf7c00153d2)
- `buffrs help`
## Synopsis
```text,ignore
Modern protobuf package management
Usage: buffrs
Commands:
init Initializes a buffrs setup
lint Check rule violations for this package
add Adds dependencies to a manifest file
remove Removes dependencies from a manifest file
package Exports the current package into a distributable tgz archive
publish Packages and uploads this api to the registry
install Installs dependencies
uninstall Uninstalls dependencies
list Lists all protobuf files managed by Buffrs to stdout
generate Generate code from installed buffrs packages
login Logs you in for a registry
logout Logs you out from a registry
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
```
## Motivation
Protocol buffers are agreeably a great way to define fully typed,
language-independent API schemas with strong backward compatibility guarantees.
They offer a neat experience for API consumers through generated bindings. *The
biggest problem associated with Protocol Buffers is their distribution.*
- How do you consume the raw protobuf files of one project reliably in another
one?
- How do you prevent transitive dependencies?
- How do you publish to a unified registry with package format across
languages?
One obvious way is to generate code bindings in the repository containing the
Protocol Buffers and publish the generated bindings, but this is associated
with problems such as language lock-in. You need to proactively publish
bindings for any possible language your API consumers may use. Also, in
strongly typed languages like Rust, it is hard to extend the behavior of
generated code in consuming projects due to _the orphan rule_. Summing up: this
approach works somehow but hurts frequently.
This is where Buffrs comes in: Buffrs solves this by defining a strict,
package-based distribution mechanism and treats Protocol Buffers as a
first-class citizen.
*This allows you to publish Buffrs packages to a registry and properly depend
on them in other projects.*
## Roadmap
- [x] Support project manifests and dependency declaration
- [x] Support package distribution via Artifactory
- [x] Support tonic as code generation backend
- [x] Support protoc as code generation backend
- [ ] Implement `buffrs-registry`, a self-hostable, S3-based registry.
- [ ] Supply tooling around Protocol Buffers, such as bindgen, linting, validation and
formatting.