AsRecordedAPP

Description

AsRecordedAPP is a dialogue management and data collection application that facilitates the organization and editing of information in Excel sheets. This application is built using PyQt5 for the graphical user interface and Pandas for data manipulation in Excel.

Table of Contents

• Description
• Features
• Project Structure
• Installation
• Usage
• Contributing
• License
• Contact

Features

• Load and view Excel sheets: Allows loading any Excel file and viewing its content within the application.
• Filter and search characters and dialogues: Quickly search through dialogues and characters using an advanced filter.
• Mark interventions as complete: An option to track progress by marking dialogues as complete.
• Edit and save changes in Excel: Changes are saved directly in the original file, making the workflow easier.
• Navigation between takes and characters: Easy and fast navigation between different takes, with the ability to filter by character.

Project Structure

AsRecordedAPP/
├── datahandler/
│   ├── __init__.py
│   ├── data_handler.py
│   ├── data_validator.py
│   ├── excel_handler.py
│   └── exceptions.py
├── gui/
│   ├── __init__.py
│   ├── main_window.py
│   ├── main_widget.py
│   ├── gidoia_widget.py
│   ├── character_filter_dialog.py
│   ├── custom_widgets.py
│   └── utils.py
├── resources/
│   └── main.css
├── PreparacionExcel/
│   ├── Excel/
│   │   └── Example Excel
│   ├── scripts/
│   │   ├── CrearTxt.py  # Creates a suitable txt for the program using the reference word
│   │   └── PandasGuion.py  # Creates the xlsx using the reference txt
│   ├── Txt/
│   │   └── Example Txt  # Recommended as a template to work with the program
│   └── Word/
│       └── Example Word  # Specific to the program used by the company
├── main.py
└── README.md

Installation

1. Navigate to the desired folder and clone this repository:

   git clone https://github.com/StablePeru/AsRecordedAPP.git
   cd AsRecordedAPP

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

   python -m venv env

   2.1 On Mac and Linux:

   source env/bin/activate

   2.2 On Windows:

   env\Scripts\activate

3. Install the dependencies:

   pip install -r requirements.txt

4. If you have issues installing any dependency, make sure pip is updated:

   python -m pip install --upgrade pip

Usage

1. Run the application:

   python main.py

2. Use the interface to load and edit Excel files, navigate between takes and characters, and mark interventions as complete.

Contributing

If you wish to contribute to this project, follow these steps:

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

Resources

• PyQt5 Documentation
• Pandas Documentation

License

This project is licensed under the MIT License.

Contact

For any questions or suggestions, please contact [email protected].