release v0.5.1

clitic · Dec 1, 2023 · 35cd16e · 35cd16e
1 parent 2e9511f
commit 35cd16e
Show file tree

Hide file tree

Showing 5 changed files with 100 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,85 @@
-kdam/README.md
+<h1 align="center">kdam</h1>
+
+<p align="center">
+  <a href="https://crates.io/crates/kdam">
+    <img src="https://img.shields.io/crates/d/kdam?style=flat-square">
+  </a>
+  <a href="https://crates.io/crates/kdam">
+    <img src="https://img.shields.io/crates/v/kdam?style=flat-square">
+  </a>
+  <a href="https://github.com/clitic/kdam">
+    <img src="https://img.shields.io/github/actions/workflow/status/clitic/kdam/tests.yml?logo=github&style=flat-square">
+  </a>
+  <a href="https://docs.rs/kdam/latest/kdam">
+    <img src="https://img.shields.io/docsrs/kdam?logo=docsdotrs&style=flat-square">
+  </a>
+  <a href="https://github.com/clitic/kdam#license">
+    <img src="https://img.shields.io/crates/l/kdam?style=flat-square">
+  </a>
+  <a href="https://github.com/clitic/kdam">
+    <img src="https://img.shields.io/github/repo-size/clitic/kdam?style=flat-square">
+  </a>
+</p>
+
+kdam is a console progress bar library for rust. It is port of [tqdm](https://github.com/tqdm/tqdm) library which is written in python. kdam supports almost all features of tqdm except a few. It also supports [jupyter notebook](https://github.com/clitic/kdam/tree/main/kdam/examples/notebook) same as tqdm does. Some features of tqdm can't be ported directly. So they are implemented in different way like, [RowManager](https://docs.rs/kdam/latest/kdam/struct.RowManager.html) which manages multiple progress bars but in tqdm progress bars are automatically managed using `nrows`. In addition to tqdm existing features kdam also provides extra features such as spinners, charset with fill, gradient colours etc. Since, kdam is written in rust its upto 4 times faster than tqdm.
+
+Instantly make your loops show a smart progress meter. Just wrap any iterator with tqdm!(iterator) macro and you're done!
+
+```rust
+use kdam::tqdm;
+
+fn main() {
+    for _ in tqdm!(0..100) {}
+}
+```
+
+```
+100%|█████████████████████████████| 100/100 [00:00<00:00, 25854.49it/s]
+```
+
+kdam also supports different bar animation styles. All available bar animation styles are:
+
+[kdam/examples/showcase/animations.rs](https://github.com/clitic/kdam/blob/main/kdam/examples/showcase/animations.rs)
+![showcase_animations](https://raw.githubusercontent.com/clitic/kdam/main/images/animations.gif)
+
+kdam also supports [rich.progress](https://rich.readthedocs.io/en/latest/progress.html) style bars with customizable columns.
+
+[kdam/examples/rich.rs](https://github.com/clitic/kdam/blob/main/kdam/examples/rich.rs)
+![showcase_rich_progress_animation](https://raw.githubusercontent.com/clitic/kdam/main/images/rich_progress.gif)
+
+kdam doesn't restrict you to use default progress bar style. You can create your own progress bar using [bar_format](https://docs.rs/kdam/latest/kdam/struct.BarBuilder.html#method.bar_format) template. If you are not satisfied with bar_format limited options then you can also build your own [custom progress bar](https://github.com/clitic/kdam/blob/main/kdam/examples/miscellaneous/custom.rs).
+
+This is clone of [alive-progress](https://github.com/rsalmei/alive-progress) using kdam.
+
+[kdam/examples/template.rs](https://github.com/clitic/kdam/blob/main/kdam/examples/template.rs)
+![showcase_alive_progress_template](https://raw.githubusercontent.com/clitic/kdam/main/images/template.gif)
+
+If you like colours then you can also create a gradient progress bar.
+
+[kdam/examples/coloured/gradient.rs](https://github.com/clitic/kdam/blob/main/kdam/examples/coloured/gradient.rs)
+![showcase_gradient](https://raw.githubusercontent.com/clitic/kdam/main/images/gradient.gif)
+
+## Getting Started
+
+Add this to your Cargo.toml file.
+
+```toml
+[dependencies]
+kdam = "0.5.0"
+```
+
+Or add from command line.
+
+```bash
+$ cargo add kdam
+```
+
+See [docs](https://docs.rs/kdam) and [examples](https://github.com/clitic/kdam/tree/main/kdam/examples) to 
+know how to use it.
+
+## License
+
+Dual Licensed
+
+- [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0) ([LICENSE-APACHE](https://github.com/clitic/kdam/blob/main/kdam/LICENSE-APACHE))
+- [MIT license](https://opensource.org/licenses/MIT) ([LICENSE-MIT](https://github.com/clitic/kdam/blob/main/kdam/LICENSE-MIT))
diff --git a/kdam/CHANGELOG.md b/kdam/CHANGELOG.md
@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.1] - 2023-10-05
+
+## Changed
+
+- Bump up pyo3 0.19 -> 0.20
+- Bump up windows-sys 0.48.0 -> 0.52.0
+
 ## [0.5.0] - 2023-10-05
 
 ## Added
@@ -191,7 +198,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [0.1.0] - 2022-03-20
 
-[Unreleased]: https://github.com/clitic/kdam/compare/v0.5.0...HEAD
+[Unreleased]: https://github.com/clitic/kdam/compare/v0.5.1...HEAD
+[0.5.1]: https://github.com/clitic/kdam/compare/v0.5.0...v0.5.1
 [0.5.0]: https://github.com/clitic/kdam/compare/v0.4.1...v0.5.0
 [0.4.1]: https://github.com/clitic/kdam/compare/v0.4.0...v0.4.1
 [0.4.0]: https://github.com/clitic/kdam/compare/v0.3.0...v0.4.0

diff --git a/kdam/Cargo.toml b/kdam/Cargo.toml
@@ -9,20 +9,20 @@ license = "MIT OR Apache-2.0"
 name = "kdam"
 readme = "README.md"
 repository = "https://github.com/clitic/kdam/tree/main/kdam"
-version = "0.5.0"
+version = "0.5.1"
 
 [dependencies]
 colorgrad = { version = "0.6", optional = true }
 formatx = { version = "0.2.1", optional = true }
 kdam_derive = { version = "0.1.0", path = "../kdam_derive", optional = true }
-pyo3 = { version = "0.19", optional = true }
+pyo3 = { version = "0.20", optional = true }
 rayon = { version = "1.8", optional = true }
 terminal_size = "0.3"
 unicode-segmentation = { version = "1", optional = true }
 unicode-width = { version = "0.1", optional = true }
 
 [target.'cfg(windows)'.dependencies]
-windows-sys = { version = "0.48.0", features = ["Win32_Foundation", "Win32_System_Console"] }
+windows-sys = { version = "0.52.0", features = ["Win32_Foundation", "Win32_System_Console"] }
 
 [features]
 derive = ["dep:kdam_derive"]

diff --git a/kdam/README.md b/kdam/README.md
@@ -65,7 +65,7 @@ Add this to your Cargo.toml file.
 
 ```toml
 [dependencies]
-kdam = "0.5.0"
+kdam = "0.5.1"
 ```
 
 Or add from command line.

diff --git a/kdam/examples/notebook/Cargo.toml b/kdam/examples/notebook/Cargo.toml
@@ -9,7 +9,7 @@ crate-type = ["cdylib"]
 
 [dependencies]
 kdam = { path = "../..", features = ["notebook", "template"] }
-pyo3 = { version = "0.19", features = ["extension-module"] }
+pyo3 = { version = "0.20", features = ["extension-module"] }
 
 [build-dependencies]
-pyo3-build-config = "0.19"
+pyo3-build-config = "0.20"