# Excel Write
[![DeepSource](https://deepsource.io/gh/themagicalmammal/excel-write.svg/?label=active+issues&show_trend=true)](https://deepsource.io/gh/themagicalmammal/excel-write/?ref=repository-badge)
[![DeepSource](https://deepsource.io/gh/themagicalmammal/excel-write.svg/?label=resolved+issues&show_trend=true)](https://deepsource.io/gh/themagicalmammal/excel-write/?ref=repository-badge)
Optimised way to write in excel files.
Developed by [Dipan Nanda](https://github.com/themagicalmammal) (c) 2023
## Example of Usage
### write_in_excel
```python
from excel_write import write_in_excel
write_in_excel(df, location, sheet)
"""
:param DataFrame df: The DataFrame used to export to Excel
:param str sheet: The name that is to be assigned to the file
:param str location: Location where the file is to be created
:param bool index: including index or not
"""
```
### auto_adjust_excel_width
```python
from excel_write import auto_adjust_excel_width
auto_adjust_column_width_index(df, writer, sheet_name="MySheet", margin=3)
"""
:param DataFrame df: The DataFrame used to export the Excel
:param pd.ExcelWriter writer: The pandas exporter with engine="xlsxwriter"
:param str sheet_name: The name of the sheet
:param int margin: How many extra space (beyond the maximum size of the string)
:param int length_factor: The factor to apply to the character length to obtain the
column width
:param int decimals: The number of decimal places to assume for floats: Should be the
same as the number of decimals displayed in the Excel
:param bool index: Whether the DataFrame's index is inserted as a separate column (if
index=False in df.to_xlsx() set index=False here!)
"""
```
## Changelog
Go [here](https://github.com/themagicalmammal/excel-write/blob/main/CHANGELOG.md) to checkout the complete changelog.
## License
#### This is under MIT License
[![License: MIT](https://img.shields.io/badge/license-MIT-blue)](https://github.com/themagicalmammal/excel-write/blob/main/LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/themagicalmammal/excel-write",
"name": "excel-write",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,excel,pandas,excel-write,write,openpyxl,xlsxwriter",
"author": "Dipan Nanda",
"author_email": "d19cyber@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ff/3b/0bc11cefd88833c05161b12da513ad495d7d70233e2d74b277af1037aa70/excel-write-1.1.0.tar.gz",
"platform": null,
"description": "\n# Excel Write\n[![DeepSource](https://deepsource.io/gh/themagicalmammal/excel-write.svg/?label=active+issues&show_trend=true)](https://deepsource.io/gh/themagicalmammal/excel-write/?ref=repository-badge)\n[![DeepSource](https://deepsource.io/gh/themagicalmammal/excel-write.svg/?label=resolved+issues&show_trend=true)](https://deepsource.io/gh/themagicalmammal/excel-write/?ref=repository-badge)\n\n\nOptimised way to write in excel files.\n\nDeveloped by [Dipan Nanda](https://github.com/themagicalmammal) (c) 2023\n\n## Example of Usage\n\n### write_in_excel\n\n```python\nfrom excel_write import write_in_excel\n\nwrite_in_excel(df, location, sheet)\n\"\"\"\n:param DataFrame df: The DataFrame used to export to Excel\n:param str sheet: The name that is to be assigned to the file\n:param str location: Location where the file is to be created\n:param bool index: including index or not\n\"\"\"\n```\n\n### auto_adjust_excel_width\n\n```python\nfrom excel_write import auto_adjust_excel_width\n\nauto_adjust_column_width_index(df, writer, sheet_name=\"MySheet\", margin=3)\n\n\"\"\"\n:param DataFrame df: The DataFrame used to export the Excel\n:param pd.ExcelWriter writer: The pandas exporter with engine=\"xlsxwriter\"\n:param str sheet_name: The name of the sheet\n:param int margin: How many extra space (beyond the maximum size of the string)\n:param int length_factor: The factor to apply to the character length to obtain the \ncolumn width\n:param int decimals: The number of decimal places to assume for floats: Should be the\nsame as the number of decimals displayed in the Excel\n:param bool index: Whether the DataFrame's index is inserted as a separate column (if\nindex=False in df.to_xlsx() set index=False here!)\n\"\"\"\n```\n\n\n## Changelog\nGo [here](https://github.com/themagicalmammal/excel-write/blob/main/CHANGELOG.md) to checkout the complete changelog.\n\n## License\n#### This is under MIT License\n[![License: MIT](https://img.shields.io/badge/license-MIT-blue)](https://github.com/themagicalmammal/excel-write/blob/main/LICENSE)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Optimised way to write in Excel files.",
"version": "1.1.0",
"split_keywords": [
"python",
"excel",
"pandas",
"excel-write",
"write",
"openpyxl",
"xlsxwriter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d88a4594c18fe42a6474bdd2d6ca5340c8dcaa9f35b6438fff1bd89a914bd940",
"md5": "cc3d3e15997ca847c4c61d91f4749864",
"sha256": "52f765fa846b1fc7e983eb2a30e8a0c63fc6d615d5eb17db8db5b98d53472d20"
},
"downloads": -1,
"filename": "excel_write-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cc3d3e15997ca847c4c61d91f4749864",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5140,
"upload_time": "2023-01-03T16:08:39",
"upload_time_iso_8601": "2023-01-03T16:08:39.909392Z",
"url": "https://files.pythonhosted.org/packages/d8/8a/4594c18fe42a6474bdd2d6ca5340c8dcaa9f35b6438fff1bd89a914bd940/excel_write-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ff3b0bc11cefd88833c05161b12da513ad495d7d70233e2d74b277af1037aa70",
"md5": "ca18b605600435187b1bdcde9dc80625",
"sha256": "cc5fb6c768494103a794e6559ae278a2196a71c3a96b20635fbb9f4c9ad1977f"
},
"downloads": -1,
"filename": "excel-write-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "ca18b605600435187b1bdcde9dc80625",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4924,
"upload_time": "2023-01-03T16:08:41",
"upload_time_iso_8601": "2023-01-03T16:08:41.080032Z",
"url": "https://files.pythonhosted.org/packages/ff/3b/0bc11cefd88833c05161b12da513ad495d7d70233e2d74b277af1037aa70/excel-write-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-03 16:08:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "themagicalmammal",
"github_project": "excel-write",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "openpyxl",
"specs": [
[
"~=",
"3.0.10"
]
]
},
{
"name": "pandas",
"specs": [
[
"~=",
"1.5.2"
]
]
}
],
"lcname": "excel-write"
}