Metadata-Version: 2.1
Name: xlsx2pandas
Version: 0.0.1
Summary: Library for obtaining pandas dataframes from xlsx and xlsm files
Author-email: Anton Potapov <fgreyeducation@gmail.com>
License: MIT License
        
        Copyright (c) 2023 Anton Potapov
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: openpyxl
Requires-Dist: pandas

# 🚀 **xlsx2pandas (PandasXcelerator)**

Part of a [`ProjectText Suite`](https://github.com/Flagro/ProjectTextSuite). xlsx2pandas (PandasXcelerator) is a Python library for extraction of tables in Excel sheets into a pandas DataFrames.

## 🌟 **Features**
TODO: features

## 📥 Installation

To install `xlsx2pandas`, use the following pip command:
```bash
pip3 install git+https://github.com/Flagro/xlsx2pandas.git
```

## 📘 **Usage**
Run `xlsx2pandas` from the bin folder with these arguments:

1. `path`: Path to the file or directory to process.
2. `--sheet`: (Optional) Comma-separated list of excel workbooks's sheets.

### 🖥️ Example Command
```bash
xlsx2pandas 'path/to/file' --sheet Sheet1,Sheet2
```

## 🤝 **Collaboration & Issues**
Open for collaboration; check the [issues page](https://github.com/Flagro/xlsx2pandas/issues) for discussions.

Here's how you can contribute:
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.
