Metadata-Version: 2.1
Name: in2xl
Version: 0.1.14
Summary: A package that allows to insert data in an XLSX file without changing the layout.
Home-page: https://github.com/gozred/python-in2xl
Author: Herzog(gozred)
License: MIT License
Keywords: python,xlsx,excel,dataframe,insert in excel,template,excel template
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# in2xl

> Readme.rst is still under construction

## About this project

In the Python programming language, there exist various proficient tools
to write data to XLSX format. Two of the most commonly used tools are
[XlsxWriter](https://pypi.org/project/XlsxWriter/) and
[openpyxl](https://pypi.org/project/openpyxl). With these tools, one can
conveniently create an Excel file or write data to an existing Excel
file. However, there are some limitations to be aware of when using
these tools. Specifically,
[XlsxWriter](https://pypi.org/project/XlsxWriter/) is capable of
creating files but not modifying them, whereas
[openpyxl](https://pypi.org/project/openpyxl) can modify files but does
not retain all formatting.

In the data science domain, such limitations can pose challenges,
especially if employees have significantly edited Excel files and only
require updated data. To address this issue, in2xl offers a simplistic
and efficient solution. This tool enables users to transfer data and
data frames directly into an Excel file without affecting the existing
formatting. Hence, in2xl can be a useful tool for data scientists
seeking to update data in pre-existing Excel files.

## Table of Contents

::: {.contents depth="2"}
:::

## Install

in2xl is available on pypi.org. Simply run `pip install in2xl` to
install it.

Requirements: \>= Python 3.7

Project dependencies installed by pip: :: lxml pandas openpyxl
ruamel.std.zipfile XlsxWriter

## Usage

The names of the functions are intentionally adapted to
[openpyxl](https://pypi.org/project/openpyxl) to make them easier to use
and to adapt existing scripts.

### Open a Workbook

It is not possible to create new workbooks using in2xl. The intended
approach is to open an existing Excel file (xlsx), insert data, and save
it. The opened file serves as a template, where a copy is generated and
modified to suit the requirements.

*Example 1:*

``` python
from in2xl import Workbook

wb = Workbook().load_workbook(path)
```

But this method is also possible:

*Example 2:*

``` python
import in2xl as ix

wb = ix.load_workbook(path)
```

### Open a Worksheet

``` python
ws = wb[sheetname]
```

### Insert data

### Save & Close

``` python
ws.save(path)
ws.close()
```

### Additional functions

Planned further functions \"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"


