Skip to content

Talyght/viewfinder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Table of Contents
  1. About Viewfinder
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About Viewfinder

Viewfinder is a user-friendly tool designed to simplify the analysis and visualization of CSV and Excel datasets. With an intuitive drag-and-drop interface, it offers a comprehensive overview, detailed statistics, and visualizations to help you understand your dataset quickly, the names comes from the viewfinder of cameras where you can get a quick preview useful information before taking the pic, in the same sense Viewfinder aims to help you get a quick preview of your dataset without having to load it on a jupiter notebook or other similar tool.

Key Features:

  • Easy Import: Drag and drop CSV or Excel files.
  • Data Overview: Quick summary of columns, types, missing values, and sample data.
  • Statistics: Descriptive stats for numerical columns.
  • Visualizations: Generate histograms to visualize data distributions.
  • Export: Export data overview and statistics to Excel.

(back to top)

Built With:

  • Python

Python

  • PyQt5

Qt logo

  • Pandas

Pandas

  • Matplotlib

MAtplotlib

(back to top)

Getting Started

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

Prerequisites

  • Make sure to have python 3.12 installed. (having a venv to run viewfinder is a bit optional, its generally a good practice to keep venvs for projects to prevent littering your local python install, but you be you, if you want to install the requirements.txt directly on your local python config feel free to do so as well)

  • set up a python virtual enviroment:

     python -m venv venv
  • activate the virtual enviroment using:

  • -On MacOs & Linux:

     source venv/bin/activate 
  • -On Windows using CMD:

     .\venv\Scripts\activate.bat

Installation

To install and set up Viewfinder, first ensure you have Python installed on your system. Clone the repository, navigate to the project directory, and install the required dependencies using pip. You can then run the application by executing the main script. Below are the step-by-step instructions:

  1. Clone the repo
 git clone https://github.com/your_username_/Project-Name.git
  1. install the dependencies using the requirements.txt file:
 pip install -r requirements.txt
  1. Run the -main.py- file:
 Python main.py

(back to top)

Usage

Just drag and drop your .csv or .xslx file on the window and see a quick preview of your dataset.

Contributing

Contributions are what make the open source community such a fantastic place to learn, inspire, and create. Any contributions you make to improve Viewfinder are greatly appreciated.

If you have suggestions for enhancements or new features, please fork the repository and create a pull request. You can also open an issue with the tag "enhancement". Don't forget to give the project a star if you like it! Thanks again for your support!

  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)

Contact

Guillermo Taly opensource@guillermotaly.com

Project Link https://github.com/Talyght/viewfinder

(back to top)

Resources

(back to top)

About

Small application to preview the contents of a CSV or Excel dataset.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages