Skip to content

Commit

Permalink
Update README and release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
pemistahl committed Mar 5, 2024
1 parent 8021cce commit 024963a
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 15 deletions.
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,24 @@
[![python build status](https://github.com/pemistahl/grex/actions/workflows/python-build.yml/badge.svg)](https://github.com/pemistahl/grex/actions/workflows/python-build.yml)
[![docs.rs](https://docs.rs/grex/badge.svg)](https://docs.rs/grex)
[![codecov](https://codecov.io/gh/pemistahl/grex/branch/main/graph/badge.svg)](https://codecov.io/gh/pemistahl/grex)
[![dependency status](https://deps.rs/crate/grex/1.4.4/status.svg)](https://deps.rs/crate/grex/1.4.4)
[![dependency status](https://deps.rs/crate/grex/1.4.5/status.svg)](https://deps.rs/crate/grex/1.4.5)
[![demo](https://img.shields.io/badge/-Demo%20Website-orange?logo=HTML5&labelColor=white)](https://pemistahl.github.io/grex-js/)

[![downloads](https://img.shields.io/crates/d/grex.svg)](https://crates.io/crates/grex)
[![crates.io](https://img.shields.io/crates/v/grex.svg)](https://crates.io/crates/grex)
[![lib.rs](https://img.shields.io/badge/lib.rs-v1.4.4-blue)](https://lib.rs/crates/grex)
[![lib.rs](https://img.shields.io/badge/lib.rs-v1.4.5-blue)](https://lib.rs/crates/grex)
![supported Python versions](https://img.shields.io/badge/Python-%3E%3D%203.8-blue?logo=Python&logoColor=yellow)
[![pypi](https://img.shields.io/badge/PYPI-v1.0.0-blue?logo=PyPI&logoColor=yellow)](https://pypi.org/project/grex)
[![pypi](https://img.shields.io/badge/PYPI-v1.0.1-blue?logo=PyPI&logoColor=yellow)](https://pypi.org/project/grex)
[![license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)

[![Linux Download](https://img.shields.io/badge/Linux%20Download-v1.4.4-blue?logo=Linux)](https://github.com/pemistahl/grex/releases/download/v1.4.4/grex-v1.4.4-x86_64-unknown-linux-musl.tar.gz)
[![MacOS Download](https://img.shields.io/badge/macOS%20x86%20Download-v1.4.4-blue?logo=Apple)](https://github.com/pemistahl/grex/releases/download/v1.4.4/grex-v1.4.4-x86_64-apple-darwin.tar.gz)
[![MacOS ARM Download](https://img.shields.io/badge/macOS%20ARM%20Download-v1.4.4-blue?logo=Apple)](https://github.com/pemistahl/grex/releases/download/v1.4.4/grex-v1.4.4-aarch64-apple-darwin.tar.gz)
[![Windows Download](https://img.shields.io/badge/Windows%20Download-v1.4.4-blue?logo=Windows)](https://github.com/pemistahl/grex/releases/download/v1.4.4/grex-v1.4.4-x86_64-pc-windows-msvc.zip)
[![Linux 64-bit Download](https://img.shields.io/badge/Linux%2064bit%20Download-v1.4.5-blue?logo=Linux)](https://github.com/pemistahl/grex/releases/download/v1.4.5/grex-v1.4.5-x86_64-unknown-linux-musl.tar.gz)
[![Linux ARM64 Download](https://img.shields.io/badge/Linux%20ARM64%20Download-v1.4.5-blue?logo=Linux)](https://github.com/pemistahl/grex/releases/download/v1.4.5/grex-v1.4.5-aarch64-unknown-linux-musl.tar.gz)

[![MacOS 64-bit Download](https://img.shields.io/badge/macOS%2064bit%20Download-v1.4.5-blue?logo=Apple)](https://github.com/pemistahl/grex/releases/download/v1.4.5/grex-v1.4.5-x86_64-apple-darwin.tar.gz)
[![MacOS ARM64 Download](https://img.shields.io/badge/macOS%20ARM64%20Download-v1.4.5-blue?logo=Apple)](https://github.com/pemistahl/grex/releases/download/v1.4.5/grex-v1.4.5-aarch64-apple-darwin.tar.gz)

[![Windows 64-bit Download](https://img.shields.io/badge/Windows%2064bit%20Download-v1.4.5-blue?logo=Windows)](https://github.com/pemistahl/grex/releases/download/v1.4.5/grex-v1.4.5-x86_64-pc-windows-msvc.zip)
[![Windows ARM64 Download](https://img.shields.io/badge/Windows%20ARM64%20Download-v1.4.5-blue?logo=Windows)](https://github.com/pemistahl/grex/releases/download/v1.4.5/grex-v1.4.5-aarch64-pc-windows-msvc.zip)
</div>

<br>
Expand Down Expand Up @@ -115,7 +119,7 @@ In order to use *grex* as a library, simply add it as a dependency to your `Carg

```toml
[dependencies]
grex = { version = "1.4.4", default-features = false }
grex = { version = "1.4.5", default-features = false }
```

The dependency *clap* is only needed for the command-line tool.
Expand All @@ -136,7 +140,7 @@ The following table shows all available flags and options:
```
$ grex -h
grex 1.4.4
grex 1.4.5
© 2019-today Peter M. Stahl <[email protected]>
Licensed under the Apache License, Version 2.0
Downloadable from https://crates.io/crates/grex
Expand Down Expand Up @@ -200,8 +204,8 @@ Miscellaneous Options:

#### 5.2.1 Default settings

Test cases are passed either from a collection via [`RegExpBuilder::from()`](https://docs.rs/grex/1.4.4/grex/struct.RegExpBuilder.html#method.from)
or from a file via [`RegExpBuilder::from_file()`](https://docs.rs/grex/1.4.4/grex/struct.RegExpBuilder.html#method.from_file).
Test cases are passed either from a collection via [`RegExpBuilder::from()`](https://docs.rs/grex/1.4.5/grex/struct.RegExpBuilder.html#method.from)
or from a file via [`RegExpBuilder::from_file()`](https://docs.rs/grex/1.4.5/grex/struct.RegExpBuilder.html#method.from_file).
If read from a file, each test case must be on a separate line. Lines may be ended with either a newline `\n` or a carriage
return with a line feed `\r\n`.

Expand Down
4 changes: 2 additions & 2 deletions README_PYPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![codecov](https://codecov.io/gh/pemistahl/grex/branch/main/graph/badge.svg)](https://codecov.io/gh/pemistahl/grex)
[![demo](https://img.shields.io/badge/-Demo%20Website-orange?logo=HTML5&labelColor=white)](https://pemistahl.github.io/grex-js/)
![supported Python versions](https://img.shields.io/badge/Python-%3E%3D%203.8-blue?logo=Python&logoColor=yellow)
[![pypi](https://img.shields.io/badge/PYPI-v1.0.0-blue?logo=PyPI&logoColor=yellow)](https://pypi.org/project/grex)
[![pypi](https://img.shields.io/badge/PYPI-v1.0.1-blue?logo=PyPI&logoColor=yellow)](https://pypi.org/project/grex)
[![license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
</div>

Expand Down Expand Up @@ -84,7 +84,7 @@ an initial correct regex which should be inspected by hand if further optimizati
pip install grex
```

The current version 1.0.0 corresponds to the latest version 1.4.4 of the Rust
The current version 1.0.1 corresponds to the latest version 1.4.5 of the Rust
library and command-line tool.

## 5. How to use?
Expand Down
17 changes: 17 additions & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
## grex 1.4.5 (released on 05 Mar 2024)

### Improvements

- Type stubs for the Python bindings are now available, allowing better static code
analysis, better code completion in supported IDEs and easier understanding of the library's API.
- The code for creating regular expressions in verbose mode has been simplified and is more performant now.
- ARM64 binaries are now provided for every major platform (Linux, macOs, Windows).

### Bug Fixes

- For a small set of special characters, *grex* produced incorrect regular expressions when
the case-insensitivity feature was enabled. This has been fixed.

### Changes
- All dependencies have been updated to their latest versions.

## grex 1.4.4 (released on 24 Aug 2023)

### Bug Fixes
Expand Down
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "grex"
version = "1.0.0"
version = "1.0.1"
authors = [{name = "Peter M. Stahl", email = "[email protected]"}]
description = "grex generates regular expressions from user-provided test cases."
readme = "README_PYPI.md"
Expand All @@ -17,6 +17,7 @@ classifiers = [
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Rust",
"Topic :: Software Development :: Libraries :: Python Modules",
"Topic :: Text Processing"
Expand All @@ -27,7 +28,7 @@ homepage = "https://github.com/pemistahl/grex"
repository = "https://github.com/pemistahl/grex"

[project.optional-dependencies]
test = ["pytest == 7.4.0"]
test = ["pytest == 8.0.2"]

[tool.maturin]
no-default-features = true
Expand Down

0 comments on commit 024963a

Please sign in to comment.