Skip to content

Prepare for release #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Prepare for release #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d391ac
docs: make readme pypi friendly
rishyak Oct 16, 2025
2ce4329
chore: bump version
rishyak Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
and apply (`--fix-inplace`) the [Beman Standard](https://github.com/bemanproject/beman/blob/main/docs/beman_standard.md)
to their repositories.

Note: `2025-06-07`: In order to make the best and quickly use of the tool in the entire organization, most of the
checks will not support the `--fix-inplace` flag in the first iteration.
**Note `2025-06-07`:** The first iteration of the tool will not support `--fix-inplace` in order to
expedite adoption across the Beman Project.

## Usage

- Display help:

```shell
$ uv run beman-tidy --help
$ beman-tidy --help
usage: beman-tidy [-h] [--fix-inplace | --no-fix-inplace] [--verbose | --no-verbose] [--require-all | --no-require-all] [--checks CHECKS] repo_path

positional arguments:
Expand All @@ -36,7 +36,7 @@ options:

```shell
# dry-run, require-all, non-verbose
$ uv run beman-tidy /path/to/exemplar --require-all
$ beman-tidy /path/to/exemplar --require-all
Summary Requirement: 18 checks passed, 1 checks failed, 5 checks skipped, 23 checks not implemented.
Summary Recommendation: 0 checks passed, 0 checks failed, 0 checks skipped, 0 checks not implemented.

Expand Down Expand Up @@ -134,9 +134,9 @@ Coverage TOTAL: 95.83% (23/24 checks passed).
- Run beman-tidy on the exemplar repository (fix issues in-place):

```shell
uv run beman-tidy path/to/exemplar --fix-inplace --verbose
beman-tidy path/to/exemplar --fix-inplace --verbose
```

## beman-tidy Development
## Working on beman-tidy

Please refer to the [Beman Tidy Development Guide](./docs/dev-guide.md) for more details.
Please refer to the [Beman Tidy Development Guide](https://github.com/bemanproject/beman-tidy/blob/main/docs/dev-guide.md) for more details.
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "beman-tidy"
version = "0.1.0"
version = "0.2.0"
description = "The Codebase Bemanification Tool"
readme = "README.md"
requires-python = ">=3.12"
Expand Down