Metadata-Version: 2.1
Name: conc_test_report
Version: 0.0.1
Summary: Generate a concise and brief summary of all concrete test result PDFs, to aid in fast and efficient review
Author-email: Arun Kishore <pypi@rpakishore.co.in>
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: pytest>=7.2.1
Requires-Dist: pandas>=1.5.3
Requires-Dist: pdfplumber==0.7.6
Project-URL: Home, https://github.com/rpakishore/Concrete_Test_Results

<!--- Heading --->
<div align="center">
  <img src="assets/report.png" alt="logo" width="100" height="auto" />
  <h1>Concrete Test Results Summary</h1>
  <p>
    Generate a concise and brief summary of all concrete test result PDFs, to aid in fast and efficient review
  </p>
<h4>
    <a href="https://github.com/rpakishore/Concrete_Test_Results#11-screenshots">View Demo</a>
  <span> · </span>
    <a href="https://github.com/rpakishore/Concrete_Test_Results#2-getting-started">Documentation</a>
  <span> · </span>
    <a href="https://github.com/rpakishore/Concrete_Test_Results/issues/">Report Bug</a>
  <span> · </span>
    <a href="https://github.com/rpakishore/Concrete_Test_Results/issues/">Request Feature</a>
  </h4>
</div>
<br />

[![tests](https://github.com/rpakishore/Concrete_Test_Results/actions/workflows/test.yml/badge.svg)](https://github.com/rpakishore/Concrete_Test_Results/actions/workflows/test.yml)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/rpakishore/Concrete_Test_Results)
![GitHub last commit](https://img.shields.io/github/last-commit/rpakishore/Concrete_Test_Results)

<!-- Table of Contents -->
<h2>Table of Contents</h2>  

- [1. About the Project](#1-about-the-project)
  - [1.1. Screenshots](#11-screenshots)
  - [1.2. Features](#12-features)
- [2. Getting Started](#2-getting-started)
  - [2.1. Installation](#21-installation)
  - [2.2. Dependencies](#22-dependencies)
- [3. Supported Material Testing Framework](#3-supported-material-testing-framework)
- [4. Roadmap](#4-roadmap)
- [5. License](#5-license)
- [6. Contact](#6-contact)
- [7. Acknowledgements](#7-acknowledgements)

<!-- About the Project -->
## 1. About the Project

This is a Jupyter notebook script that programmically reads and extracts data out of concrete test reports into a summarized excel file and PDF summary report
<!-- Screenshots -->
### 1.1. Screenshots

<div align="center"> 
  <img src="assets/PDFXEdit_TOuqdTL0CR.png" alt="Summary" />
  <img src="assets/PDFXEdit_4Xm5KQLlBj.png" alt="Sample Graph" />
  <img src="assets/EXCEL_dZOZkBohTr.png" alt="Excel" />
</div>

<!-- Features -->
### 1.2. Features

PDF summary of the compiled data with the following additional verifications  

- Target vs Achived strength graph to quickly check if req. strength is achieved  
- Checks for Air content % to meet specified range
- Checks for slump to meet specified range

## 2. Getting Started

<!-- Prerequisites -->
### 2.1. Installation

From Pypi

```bash
pip install conc_test_report
```

### 2.2. Dependencies

The package should be pre-compiled with all required dependencies

## 3. Supported Material Testing Framework

This project will always remain a work in progress. A list of supported material testing report formats are shown below. More will be added in the future.

If you would like to see a particular company, please open up a [new issue](https://github.com/rpakishore/Concrete_Test_Results/issues/)

| Company | Status |
|---------|--------|
| McElhanney | ✔️ |
| Kontur Geotechnical Consultants | ✔️ |

## 4. Roadmap

- [ ] Report Parser Script
  - [ ] Group common data extraction functions under `Company` class
  - [ ] Seperate patters to isolate one group per line
- [ ] Report Generator Script
- [ ] Tests

<!-- License -->
## 5. License

See LICENSE.txt for more information.

<!-- Contact -->
## 6. Contact

Arun Kishore - <a href="mailto:pypi@rpakishore.co.in?subject=[Concrete Test Results Summary]">@rpakishore</a>

Project Link: [https://github.com/rpakishore/Concrete_Test_Results](https://github.com/rpakishore/Concrete_Test_Results/)

<!-- Acknowledgments -->
## 7. Acknowledgements

Use this section to mention useful resources and libraries that you have used in your projects.

- [Awesome README Template](https://github.com/Louis3797/awesome-readme-template/blob/main/README-WITHOUT-EMOJI.md)
- <a href="https://www.flaticon.com/free-icons/report" title="report icons">Report icons created by Freepik - Flaticon</a>

