Code-Formatter-Advisor

Code-Formatter-Advisor is a command-line tool that leverages GroqCloud API to analyze code and provide formatting improvement suggestions. It offers a streamlined interface for specifying input files, customizing outputs, and enhancing code readability and consistency. The tool supports multiple programming languages and integrates seamlessly into your workflow by delivering suggestions directly in the terminal or saving them to a file.

📜Description

• Provides code formatting suggestions based on best practices.
• Supports multiple programming languages.
• Easy-to-use command-line interface.
• Ability to output suggestions to a file or display them in the terminal.

⚙️Installation

Option 1: Install via PyPI (Recommended)

You can install Code-Formatter-Advisor directly from PyPI using pip:

pip install code-formatter-advisor

Option 2: Install from Source

1. Clone the repository:

   git clone https://github.com/Elisassa/Code-Formatter-Advisor.git
   cd Code-Formatter-Advisor

2. Create a virtual environment (optional but recommended):

   python -m venv venv
   source venv/bin/activate # On Windows use `venv\Scripts\activate`

3. Install the required dependencies:

   pip install -r requirements.txt

📝Usage

Command-Line Arguments

• --output or -o: Specify the output file name for the suggestions.
• --version or -v: Display the version of the tool.
• files: The code files to be analyzed (one or more).

Example Commands

1. Analyze a single file and display suggestions in the terminal:

   code-formatter-advisor test.py

2. Analyze multiple files and save suggestions to an output file:

   code-formatter-advisor test1.py test2.py --output suggestions.txt

3. Check the version of the tool:

   code-formatter-advisor --version

Usage After Installing via PyPI

If you installed Code-Formatter-Advisor using pip, you can simply run the following commands from anywhere:

1. Analyze a single file and display suggestions in the terminal:

   code-formatter-advisor test.py

2. Analyze multiple files and save suggestions to an output file:

   code-formatter-advisor test1.py test2.py --output suggestions.txt

3. Check the version of the tool:

   code-formatter-advisor --version

🔍Demonstration

The Code-Formatter-Advisor analyzes your code and provides actionable formatting suggestions to improve readability and consistency. Below is a demonstration of how the tool works:

Original Unformatted Code:

Below is an example of code before using Code-Formatter-Advisor. Notice the issues such as inconsistent indentation, missing type hints, and lack of descriptive comments.

Suggested Improvements by Code-Formatter-Advisor:

After running the code through Code-Formatter-Advisor, the tool suggests various improvements such as:

• Consistent Indentation: Standardizes indentation to 4 spaces for better readability.
• Removal of Extra Spaces: Removes unnecessary spaces around function arguments, colons, and assignment operators.
• Descriptive Function Names: Renames functions to be more descriptive, like changing add_numbers to sum_numbers.
• Addition of Docstrings: Adds docstrings to describe the purpose and usage of functions, making the code self-documenting.
• Type Hints: Adds type hints to function arguments and return values to clarify the expected input and output.

🛠️How Code-Formatter-Advisor Was Created

Project Setup

1. Initialization: The project was initialized by setting up a basic Python environment using venv to manage dependencies.

2. Dependencies: Required libraries were defined and installed via a requirements.txt file, including argparse for command-line argument parsing, dotenv for environment variable management, and others for formatting analysis.

3. Development:

   • The main logic is implemented in main.py, which handles reading files, interacting with the code formatting API, and processing user inputs.
   • argparse is used to handle command-line arguments, allowing users to specify files, output locations, and other options.
   • A custom API client (Groq) was integrated to analyze code and provide formatting suggestions.

🚀 Release Information

The package is available on PyPI and can be installed via:

pip install code-formatter-advisor

To view the source code, report issues, or contribute to the project, please visit the GitHub repository: Code-Formatter-Advisor on GitHub

Versioning

The current version is v1.0.0. The versioning follows Semantic Versioning, and any new features, bug fixes, or changes will be released accordingly.

🛠️ How to Use the Release

1. Install the Package: Users can install the package from PyPI using pip.
2. Run the Command: Use the code-formatter-advisor command followed by the file(s) you want to analyze.
3. Follow the Suggestions: The tool provides suggestions to improve code formatting, which can be seen in the terminal or saved to a file.

🧑‍💻 User Feedback and Updates

User testing was conducted to ensure that the installation process and usage instructions were straightforward. Feedback from testers helped refine the README and the overall user experience. If you encounter any issues, feel free to create an issue on GitHub.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.