From 59e20ee575057d7b5f75c84bb3810e4b93066d21 Mon Sep 17 00:00:00 2001 From: liblaf <30631553+liblaf@users.noreply.github.com> Date: Sat, 30 Nov 2024 20:15:51 +0800 Subject: [PATCH] docs: update README and utility function for consistency - Corrects the PyPI badge color and CI badge label in the README - Removes redundant installation instructions in the README - Updates the command alias in the README for local development - Adjusts the import path in the utility function to match the package structure --- README.md | 12 +++--------- src/ai/utils/_get_prompt.py | 2 +- uv.lock | 2 +- 3 files changed, 5 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index c28ed1d..d66f8af 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,11 @@ LLM CLI is a powerful, open-source command-line interface for AI-driven reposito -[pypi-release-shield]: https://img.shields.io/pypi/v/liblaf-ai-cli?logo=pypi&style=flat&label=PyPI +[pypi-release-shield]: https://img.shields.io/pypi/v/liblaf-ai-cli?color=3775a9&logo=pypi&logoColor=white&style=flat&label=PyPI [pypi-release-link]: https://pypi.org/project/liblaf-ai-cli/ [github-releasedate-shield]: https://img.shields.io/github/release-date/liblaf/ai-cli?style=flat [github-releasedate-link]: https://github.com/liblaf/ai-cli/releases -[github-action-ci-shield]: https://img.shields.io/github/actions/workflow/status/liblaf/ai-cli/ci.yaml?label=ci&logo=githubactions&logoColor=white&style=flat +[github-action-ci-shield]: https://img.shields.io/github/actions/workflow/status/liblaf/ai-cli/ci.yaml?label=CI&logo=githubactions&logoColor=white&style=flat [github-action-ci-link]: https://github.com/liblaf/ai-cli/actions/workflows/ci.yaml [github-contributors-shield]: https://img.shields.io/github/contributors/liblaf/ai-cli?color=c4f042&style=flat [github-contributors-link]: https://github.com/liblaf/ai-cli/graphs/contributors @@ -46,12 +46,6 @@ To install `ai-cli`, run the following command: uv tool install liblaf-ai-cli ``` -or - -```bash -pipx install liblaf-ai-cli -``` - ## ⌨️ Local Development You can clone it for local development: @@ -60,7 +54,7 @@ You can clone it for local development: gh repo clone liblaf/ai-cli cd ai-cli uv sync --all-extras -ai-cli --help +ai --help ``` ## 🤝 Contributing diff --git a/src/ai/utils/_get_prompt.py b/src/ai/utils/_get_prompt.py index fb1cc07..fb8bbb2 100644 --- a/src/ai/utils/_get_prompt.py +++ b/src/ai/utils/_get_prompt.py @@ -3,6 +3,6 @@ def get_prompt(name: str) -> str: - prompts_dir: Traversable = importlib.resources.files("ai_cli.assets.prompts") + prompts_dir: Traversable = importlib.resources.files("ai.assets.prompts") fpath: Traversable = prompts_dir / f"{name}.md" return fpath.read_text() diff --git a/uv.lock b/uv.lock index 3d6bebe..91be34b 100644 --- a/uv.lock +++ b/uv.lock @@ -472,7 +472,7 @@ wheels = [ [[package]] name = "liblaf-ai-cli" -version = "0.0.0" +version = "0.0.1" source = { editable = "." } dependencies = [ { name = "gitpython" },