Location Validator

A powerful tool to validate Master Data - Location before importing into CMMS.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

The Location Validator is a specialized tool designed to ensure the integrity and accuracy of location data before it is imported into a Computerized Maintenance Management System (CMMS). It automates the validation process, checking for format consistency, duplicate entries, and adherence to specific coding standards (System, EQ, Component).

Key Features:

• Automated Validation: Quickly checks thousands of location entries against defined rules.
• User-Friendly GUI: Simple and intuitive interface for selecting files and running validations.
• Detailed Reporting: Generates comprehensive Excel reports highlighting errors and suggesting corrections.
• Customizable: Easily configure input files and database references.

(back to top)

Built With

This project is built using Python and several powerful libraries to handle data processing and the graphical user interface.

• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

You need to have Python installed on your machine. You can download it from python.org.

Installation

1. Clone the repo

   git clone https://github.com/naravid19/cmms-location-validator.git

2. Install Python packages

   pip install -r requirements.txt

(back to top)

Usage

1. Run the Application: You can run the application using Python:

   python gui_app.py

   Or run the executable if you have built it.

2. Configure Settings:

   • Sheet Name: Enter the name of the sheet containing location data.
   • Input File: Select your Excel file with the location data to be validated.
   • Database Code: Select the reference database Excel file.

3. Run Validation: Click the "Run Validation" button. The application will process the data and generate a report in the same directory as your input file.

(back to top)

Roadmap

• Core Validation Logic
• Graphical User Interface (GUI)
• Executable Build Script
• Advanced Reporting Features
• Multi-language Support

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Narawit - @naravid19

Project Link: https://github.com/naravid19/cmms-location-validator

(back to top)

Acknowledgments

• CustomTkinter
• Pandas
• OpenPyXL
• Best-README-Template

(back to top)