Skip to content
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

docs: update pyproject.toml and readme #107

Merged
merged 1 commit into from
Dec 16, 2024
Merged

docs: update pyproject.toml and readme #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,4 +149,4 @@ clang-format, clang-tidy, clang-query, clang-apply-replacements
Thanks to the project
`clang-tools-static-binaries <https://github.com/muttleyxd/clang-tools-static-binaries>`_.
We now used the `fork repository <https://github.com/cpp-linter/clang-tools-static-binaries>`_
that fixed the clang-tidy v14+ Segmentation fault (core dumped). see `#56 <https://github.com/cpp-linter/clang-tools-pip/issues/56>`_ for details.
that fixed the clang-tidy v14+ Segmentation fault (core dumped). see `#56 <https://github.com/cpp-linter/clang-tools-pip/issues/56>`_ for details and other related build issues.
6 changes: 3 additions & 3 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ build-backend = "setuptools.build_meta"

[project]
name = "clang_tools"
description = "Install clang-tools (clang-format, clang-tidy) with pip"
description = "Install clang-tools (clang-format, clang-tidy, clang-query, clang-apply-replacements) with pip"
readme = "README.rst"
keywords = ["clang", "clang-tools", "clang-extra", "clang-tidy", "clang-format"]
keywords = ["clang", "clang-tools", "clang-extra", "clang-tidy", "clang-format", "clang-query", "clang-apply-replacements"]
license = {text = "MIT License"}
authors = [
{ name = "Xianpeng Shen", email = "[email protected]" },
{ name = "Brendan Doherty", email = "[email protected]" },
]
classifiers = [
# https://pypi.org/pypi?%3Aaction=list_classifiers
"Development Status :: 4 - Beta",
"Development Status :: 5 - Production/Stable",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Based on the comprehensive verification results, I can now provide the final response:

Production status upgrade needs additional criteria to be met

The project shows good engineering practices with:

  • Comprehensive test suite with unit tests for core functionality
  • Robust CI/CD pipeline with multiple workflows
  • Wide platform support (Windows, macOS, Linux)
  • Version compatibility testing (Python 3.10)

However, some production-readiness criteria are missing:

  • No README.md found for user documentation
  • No CHANGELOG.md for tracking breaking changes
  • No test coverage metrics visible
  • No conftest.py for shared test configurations

The status should remain at Beta (4) until these gaps are addressed.

🔗 Analysis chain

Verify production readiness criteria

Upgrading from Beta to Production/Stable is a significant change that implies production readiness. Let's verify this status change is justified.

Let me gather more information about the project's stability and production readiness.

Let me gather one final piece of information about test coverage and documentation quality.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for indicators of production readiness

# Check for presence of tests
echo "Checking test coverage:"
fd -e py -p "test_.*\.py$"

# Check for recent releases and tags
echo "Checking release history:"
git tag -l --sort=-creatordate | head -n 5

# Check for open critical issues
echo "Checking for critical issues:"
gh issue list --label "bug" --state open --limit 10

Length of output: 372

Script:

#!/bin/bash
# Check test quality and CI status
echo "Checking test configurations:"
cat tests/conftest.py 2>/dev/null || echo "No conftest.py found"
echo -e "\nChecking CI workflow:"
fd -e yml -e yaml . .github/workflows/
cat $(fd -e yml -e yaml . .github/workflows/) 2>/dev/null

# Check documentation completeness
echo -e "\nChecking documentation:"
fd "README|CONTRIBUTING|CHANGELOG" -e md

# Check version history stability
echo -e "\nChecking version history:"
git log --oneline -n 10

Length of output: 9045

Script:

#!/bin/bash
# Check test coverage report and documentation
echo "Checking test contents:"
cat tests/test_*.py

echo -e "\nChecking documentation quality:"
cat README.md CONTRIBUTING.md

Length of output: 7961

"Intended Audience :: Developers",
"Intended Audience :: System Administrators",
"Intended Audience :: Information Technology",
Expand Down
Loading