PySpaceCleaner is a Python-based tool designed to efficiently remove all whitespaces from a given file. With PySpaceCleaner, users can automate the process of whitespace removal, saving time and effort compared to manually editing files line by line. This tool is particularly useful for cleaning up text files, code files, or other plain-text documents where whitespace can affect formatting or data processing.
PySpaceCleaner supports a simple and intuitive command-line interface, allowing users to specify the file they wish to process. Once executed, the tool reads the file, removes all extraneous whitespace (including spaces, tabs, and line breaks), and overwrites the file with the cleaned content. This ensures that the output is concise and free from unnecessary characters, making it ideal for tasks such as preparing data for analysis, optimizing code readability, or adhering to strict formatting guidelines.
PySpaceCleaner is designed for simplicity and ease of use. To run the program, navigate to the directory containing the main file, located at PySpaceCleaner/src/code, and execute the following command: python main.py /path/to/your/library, replacing /path/to/your/library with the absolute or relative path to the directory you wish to clean. To run the code you have to be in the folder of the main.py's file. It is located in the PySpaceCleaner/src/code folder.
Ease of Use: A straightforward interface to quickly process files with minimal effort.
Automation: Removes the need for manual editing by automating whitespace removal across entire files.
Reliability: Processes files securely, ensuring no data is lost aside from unwanted whitespace.
Versatility: Applicable to a variety of use cases, such as cleaning up large datasets, preparing scripts for deployment, or refining configuration files.
Contributions to this project are highly encouraged and greatly appreciated. If you would like to contribute, please follow these steps to ensure a smooth and efficient collaboration:
Open an Issue: Before making changes, open an issue in the project's GitHub repository. Clearly describe the bug, feature request, or improvement you plan to work on. This helps maintainers and other contributors provide guidance and avoid duplicate efforts.
Fork the Repository: Fork the project's repository to your GitHub account to create a personal copy for your development work.
Create a New Branch: In your forked repository, create a new branch for your contribution. Use a descriptive branch name, such as feature/new-feature or fix/bug-description, to clearly indicate the purpose of the branch.
Make Changes: Implement your changes in the new branch. Ensure your code adheres to the project's coding standards and is well-documented.
Test Your Changes: Verify that your changes work as expected by running the project's test suite or adding new tests where appropriate.
Submit a Pull Request (PR): Once your changes are complete and tested, submit a pull request to the original repository. Include a clear and detailed description of the changes in your PR, referencing the issue you are addressing if applicable.