This repository holds the Rust libraries of GitGuardian.
Public crates are published to crates.io. Internal crates are not published. Other projects use them as git dependencies pinned by tag.
| Crate | Kind | Description |
|---|---|---|
| gitguardian-api | public | Request definitions and models for the GitGuardian API |
| gitguardian-client | public | GitGuardian API client with ureq and reqwest backends |
| gg_url | internal | URL handling for GitGuardian products |
| gg_fs | internal | Filesystem operations with secure, portable defaults |
| gitguardian-mock | internal | Local mock of the GitGuardian API for end to end tests |
gitguardian-mock is only used by the tests of this repository. It is not tagged.
Add the crate from crates.io.
cargo add gitguardian-clientInternal crates are geared towards being used in other projects of the gitguardian codebase. Support for external feature requests and bug investigation is limited. Add the crate as a git dependency. The tag names the crate and its version.
gg_fs = { git = "https://github.com/GitGuardian/rust-libraries", tag = "gg_fs-v0.1.0" }To upgrade, change the tag. Internal crates may change their API in any minor version.
The crates are released under the MIT license.