html-table-to-json 0.1.0

Effortlessly convert HTML tables to JSON with this Python-based tool.

HTML Table to JSON Converter

Leia em Português

Description

This project is a converter that reads a table from an HTML file and transforms it into a JSON file. It uses the pandas and BeautifulSoup libraries to perform the conversion efficiently and in a structured manner. The project follows Clean Architecture, Clean Code, and SOLID principles, ensuring modular, readable, and maintainable code.

Project Structure

html-table-to-json/
├── src/
│   ├── main.py
│   ├── services/
│   │   ├── html_parser.py
│   │   ├── json_converter.py
│   │   └── file_handler.py
│   └── utils/
│       └── logger.py
├── requirements.txt
├── README.md
├── LICENSE.md
└── .gitignore

Installation

Prerequisites

• Python 3.6 or higher
• Pip (Python package manager)

Steps

1. Clone the repository:

   git clone https://github.com/your-username/html-table-to-json.git
   cd html-table-to-json
   

2. Create a virtual environment:

   python -m venv venv
   

3. Activate the virtual environment:

   • On Windows:

     venv\Scripts\activate
     

   • On macOS/Linux:

     source venv/bin/activate
     

4. Install dependencies:

   pip install -r requirements.txt
   

Usage

To convert a table from an HTML file to JSON, follow these steps:

1. Navigate to the src directory:

   cd src
   

2. Run the main.py script, passing the path of the HTML file as an argument:

   python main.py path/to/your/file.html
   

3. The resulting JSON will be saved to output/out.json.

Example

If you have an HTML file named table.html in the root of the project, run:

python main.py ../table.html

The JSON will be saved in output/out.json and logs will be stored in logs/html_table_to_json.log.

Code Structure

main.py

Entry point of the program. Coordinates reading the HTML file, parsing, conversion, and writing the output JSON.

services/file_handler.py

Contains functions for reading and writing files.

services/html_parser.py

Contains functions for parsing HTML using BeautifulSoup.

services/json_converter.py

Contains functions for converting the HTML table to JSON using Pandas.

utils/logger.py

Configures and initializes the logger to record important events and errors.

Contribution

1. Fork the project
2. Create a branch for your feature (git checkout -b feature/new-feature)
3. Commit your changes (git commit -m 'Add new feature')
4. Push to the branch (git push origin feature/new-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License. See the LICENSE.md file for more details.

Contact

For more information, contact via email at [e-mail].