From 396bf611e16fa33d4a27b8b115e31edaddfb7c4f Mon Sep 17 00:00:00 2001 From: Jerus Bot <171541392+jerus-bot@users.noreply.github.com> Date: Tue, 30 Sep 2025 06:33:49 +0000 Subject: [PATCH] chore: Release cull-gmail v0.0.1 --- CHANGELOG.md | 8 ++--- Cargo.lock | 2 +- Cargo.toml | 2 +- PRLOG.md | 2 +- README.md | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++-- docs/lib.md | 2 +- 6 files changed, 93 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 73030f4..0a896e4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,16 +5,16 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] - +## [0.0.1] - 2025-09-30 -Summary: Added[4], Build[3], Chore[19], Continuous Integration[4], Documentation[6] +Summary: Added[4], Build[3], Chore[20], Continuous Integration[4], Documentation[7] ### Added - - ✨ feat(vscode): add custom dictionary entry for ltex - ✨ feat(assets): add new logo and splash screen - - ✨ feat(lib): add addition function with test - ✨ feat(project): add initial Cargo.toml for cull-gmail tool + - ✨ feat(lib): add addition function with test + - ✨ feat(vscode): add custom dictionary entry for ltex [Unreleased]: https://github.com/jerus-org/cull-gmail/commits/main/ diff --git a/Cargo.lock b/Cargo.lock index 0ac50be..1d2c613 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4,4 +4,4 @@ version = 4 [[package]] name = "cull-gmail" -version = "0.0.0" +version = "0.0.1" diff --git a/Cargo.toml b/Cargo.toml index 5f47bd7..d68d9a9 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,7 +2,7 @@ name = "cull-gmail" description = """Tool to assist in culling emails from a gmail account using the gmail API""" -version = "0.0.0" +version = "0.0.1" authors = ["Jeremiah Russell "] edition = "2024" rust-version = "1.87" diff --git a/PRLOG.md b/PRLOG.md index b407ac0..ebfcc0d 100644 --- a/PRLOG.md +++ b/PRLOG.md @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] +## [0.0.1] - 2025-09-30 ### Changed diff --git a/README.md b/README.md index e309672..a2d7749 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,85 @@ -# cull-gmail -Program to manage the end of life gmail messages. +![cull-gmail — Generate a change log based on the git commits compatible with keep-a-changelog and using conventional commits to categorize commits][splash] + +[splash]: https://raw.githubusercontent.com/jerus-org/cull-gmail/main/assets/splash.svg + +[![Rust 1.87+][version-badge]][version-url] +[![circleci-badge]][circleci-url] +[![Crates.io][crates-badge]][crates-url] +[![Docs][docs-badge]][docs-url] +[![MIT licensed][mit-badge]][mit-url] +[![BuyMeaCoffee][bmac-badge]][bmac-url] +[![GitHubSponsors][ghub-badge]][ghub-url] + +[crates-badge]: https://img.shields.io/crates/v/cull-gmail.svg +[crates-url]: https://crates.io/crates/gen-changlog +[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg +[mit-url]: https://github.com/jerusdp/cull-gmail/blob/main/LICENSE-MIT +[apache-badge]: https://img.shields.io/badge/license-APACHE-blue.svg +[apache-url]: https://github.com/jerusdp/cull-gmail/blob/main/LICENSE-APACHE +[circleci-badge]: https://dl.circleci.com/status-badge/img/gh/jerus-org/cull-gmail/tree/main.svg?style=svg +[circleci-url]: https://dl.circleci.com/status-badge/redirect/gh/jerus-org/cull-gmail/tree/main +[version-badge]: https://img.shields.io/badge/rust-1.87+-orange.svg +[version-url]: https://www.rust-lang.org +[docs-badge]: https://docs.rs/cull-gmail/badge.svg +[docs-url]: https://docs.rs/cull-gmail +[bmac-badge]: https://badgen.net/badge/icon/buymeacoffee?color=yellow&icon=buymeacoffee&label +[bmac-url]: https://buymeacoffee.com/jerusdp +[ghub-badge]: https://img.shields.io/badge/sponsor-30363D?logo=GitHub-Sponsors&logoColor=#white +[ghub-url]: https://github.com/sponsors/jerusdp + +The `cull-gmail` provides a software library and command line program to enable the culling of emails using the Gmail API. + +## Main Features + +- login to get authorization +- backup the mailbox +- filtered lists of the contents +- move email matching a filtered list to trash +## cull-gmail Library Documentation + +The `cull-gmail` library provides types to enable the culling of emails using the Gmail API including the following steps: +- login to get authorization +- backup the mailbox +- filtered lists of the contents +- move email matching a filtered list to trash + +### Installation + +Add the library to your program's `Cargo.toml` using `cargo add`: + +```bash +$ cargo add cull-gmail +``` + +Or by configuring the dependencies manually in `Cargo.toml`: + +```toml +[dependencies] +cull-gmail = "0.0.1" +``` + +## cull-gmail CLI + +A command line program to cull emails from Gmail using the Gmail API. The tool has sub-commands to for authorization, planning and executing the move of select email to the Gmail trash folder from which they will be automatically deleted after thirty days. + +### Installation + +Install cull-gmail using Cargo: + +```bash +cargo install cull-gmail +``` + +## License + +By contributing to cull-gmail, you agree that your contributions will be licensed under the MIT License. This means: + +- You grant permission for your contributions to be used, modified, and distributed under the terms of the MIT License +- You confirm that you have the right to submit the code under this license +- You understand that your contributions will become part of the project and available to all users under the MIT License + +## Contribution + +Thank you for your interest in contributing to cull-gmail! We welcome contributions from the community and appreciate your help in making this project better. + +Further details can be found in the [contribution document](CONTRIBUTING.md). diff --git a/docs/lib.md b/docs/lib.md index 19ca3a4..aac3c29 100644 --- a/docs/lib.md +++ b/docs/lib.md @@ -18,6 +18,6 @@ Or by configuring the dependencies manually in `Cargo.toml`: ```toml [dependencies] -cull-gmail = "0.1.0" +cull-gmail = "0.0.1" ```