Skip to content

Overture-7421/OverScouting

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 

Repository files navigation

OverScouting App Documentation

Overview

The OverScouting App is an innovative desktop application designed for FIRST FRC teams to streamline the process of scouting at competitions. Built with Python and utilizing the Tkinter library for its graphical user interface, this app offers a user-friendly platform for entering, managing, and saving scouting data collected via QR codes into CSV and TXT files. The app features an ASCII art logo, autosave functionality, and the ability to undo previous entries, enhancing data management efficiency during the hectic environment of FRC competitions.

Features

  • ASCII Art Logo: Displays a custom ASCII art logo on startup, representing the team spirit and technological engagement.
  • Data Entry via QR Codes: Facilitates the entry of scouting data scanned from QR codes, simplifying the data collection process.
  • Undo Functionality: Allows users to undo their last action, providing a safety net for accidental entries or deletions.
  • Autosave Mechanism: Periodically saves data to backup files, ensuring that scouting data is not lost unexpectedly.
  • Save to CSV and TXT: Offers the ability to save scouting data into CSV and TXT formats, providing flexibility for data analysis and sharing.
  • Customizable Save Location: Enables users to select their preferred save location for CSV and TXT files, enhancing user control over data storage.
  • User-friendly Interface: Features a simple and intuitive GUI, making it easy for team members to use the app with minimal training.

Installation

To run the OverScouting App, you will need Python installed on your system. The application has been developed and tested with Python 3.8+, and it utilizes the Tkinter library, which is included with Python.

  1. Install Python: Download and install Python from the official website. Ensure you select the option to add Python to your system's PATH during installation.
  2. Download the Application: Download the OverScoutingApp.py file to your local machine.
  3. Run the Application: Open a terminal or command prompt, navigate to the directory containing OverScoutingApp.py, and run the command python OverScoutingApp.py.

Usage

Upon launching the OverScouting App, users are greeted with an ASCII art logo and a simple, intuitive interface. Here is how to use the core features of the app:

  • Entering Data: Paste or type scouting data into the text area. Data should be formatted as expected from QR code scans.
  • Adding Entries: Click the "Add Entry" button to save the current state before adding new data. This action enables the undo functionality.
  • Undoing Changes: Click the "Undo" button to revert to the last saved state, useful for correcting mistakes.
  • Saving Data: Click the "Save CSV" button to save the entered data. You will be prompted to choose a save location and file name for both CSV and TXT files.

Development

The OverScouting App was developed by FIRST FRC Team Overture - 7421 as a tool to aid in the collection and management of scouting data during competitions. The project is open for contributions and improvements from the community.

Contributing

We welcome contributions to the OverScouting App. To contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or fix.
  3. Commit your changes with clear, descriptive messages.
  4. Push your changes to the branch and open a pull request.

License

The OverScouting App is released under the MIT License. See the LICENSE file in the project repository for more details.

Support

For support, questions, or feedback, please open an issue in the project repository on GitHub.