Skip to content

Commit 4532abd

Browse files
committed
First commit
0 parents  commit 4532abd

24 files changed

+3022
-0
lines changed

.github/FUNDING.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
github: xuri
2+
open_collective: excelize
3+
patreon: xuri
4+
ko_fi: xurime
5+
liberapay: xuri
6+
issuehunt: xuri
7+
custom: https://www.paypal.com/paypalme/xuri
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Docs issues
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
<!--
8+
If you are reporting a new issue, make sure that we do not have any duplicates
9+
already open. You can ensure this by searching the issue list for this
10+
repository. If there is a duplicate, please close your issue and add a comment
11+
to the existing issue instead.
12+
13+
Use the commands below to provwide key information.
14+
-->
15+
16+
**Description**
17+
18+
<!--
19+
Briefly describe the problem you are having in a few paragraphs. Share your
20+
experience with us, but please don't include sensitive or personal information.
21+
-->
22+
23+
**The reason for your feedback**
24+
25+
<!--- What types of feedback? Put an `x` in all the boxes that apply: -->
26+
27+
- [ ] Content is hard to understand
28+
- [ ] Procedure or code doesn't work
29+
- [ ] Couldn't find what I need
30+
- [ ] Out of date/obsolete
31+
- [ ] Other
32+
33+
**Docs URL:**
34+
35+
```text
36+
(paste here)
37+
```

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# PR Details
2+
3+
<!--- Provide a general summary of your changes in the Title above -->
4+
5+
## Description
6+
7+
<!--- Describe your changes in detail -->
8+
9+
## Related Issue
10+
11+
<!--- This project only accepts pull requests related to open issues -->
12+
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
13+
<!--- If fixing a issue, there should be an issue describing it with steps to reproduce -->
14+
<!--- Please link to the issue here: -->
15+
16+
## Motivation and Context
17+
18+
<!--- Why is this change required? What problem does it solve? -->

.github/SECURITY.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
We will dive into any security-related issue as long as your excelize-py-docs version is still supported by us. When reporting an issue, include as much information as possible, but no need to fill fancy forms or answer tedious questions. Just tell us what you found, how to reproduce it, and any concerns you have about it. We will respond as soon as possible and follow up with any missing information.
6+
7+
## Reporting a Vulnerability
8+
9+
Please e-mail us directly at `xuri.me at gmail.com` or use the security issue template on GitHub. In general, public disclosure is made after the issue has been fully identified and a patch is ready to be released. A security issue gets the highest priority assigned and a reply regarding the vulnerability is given within a typical 24 hours. Thank you!

.github/linter-rules.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
default: true
2+
MD013: false
3+
MD033: false
4+
MD036: false
5+
MD041: false

.github/workflows/markdown.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
on: [push, pull_request]
2+
name: lint
3+
jobs:
4+
markdown-lint:
5+
runs-on: ubuntu-latest
6+
steps:
7+
8+
- name: Check out code
9+
uses: actions/checkout@v4
10+
11+
- name: Markdown Linting Action
12+
uses: avto-dev/markdown-lint@v1.5.0
13+
with:
14+
args: './'
15+
config: '.github/linter-rules.yml'

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules/
2+
_book/
3+
**/.DS_Store

LANGS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Languages
2+
3+
* [English](en)

book.json

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"title": "Excelize for Python",
3+
"author": "xuri",
4+
"language": "en",
5+
"plugins": [
6+
"-sharing",
7+
"-lunr",
8+
"-search",
9+
"search-plus",
10+
"scripts",
11+
"sitemap-general",
12+
"language-picker",
13+
"favicon"
14+
],
15+
"pluginsConfig": {
16+
"favicon": {
17+
"shortcut": "https://xuri.me/excelize-py/images/favicon.ico",
18+
"bookmark": "https://xuri.me/excelize-py/images/favicon.ico",
19+
"appleTouch": "https://xuri.me/excelize-py/images/logo_trans_300x300.png",
20+
"appleTouchMore": {
21+
"120x120": "https://xuri.me/excelize-py/images/apple-touch-icon-120x120.png",
22+
"180x180": "https://xuri.me/excelize-py/images/apple-touch-icon-180x180.png"
23+
}
24+
},
25+
"sitemap-general": {
26+
"prefix": "https://xuri.me/excelize-py/"
27+
},
28+
"scripts": {
29+
"files": []
30+
}
31+
},
32+
"pdf": {
33+
"fontSize": 10,
34+
"pageNumbers": false,
35+
"paperSize": "a4",
36+
"margin": {
37+
"right": 0,
38+
"left": 0,
39+
"top": 0,
40+
"bottom": 0
41+
},
42+
"headerTemplate": null,
43+
"footerTemplate": null
44+
}
45+
}

en/README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Introduction
2+
3+
<p align="center"><img width="650" src="../images/excelize-py.svg" alt="Excelize for Python logo"></p>
4+
5+
Excelize for Python is a Python port of Go [Excelize](https://github.com/xuri/excelize) library, providing a set of functions that allow you to write and read from XLAM / XLSM / XLSX / XLTM / XLTX files. Supports reading and writing spreadsheet documents generated by Microsoft Excel&trade; 2007 and later. Supports complex components by high compatibility, and provided streaming API for generating or reading data from a worksheet with huge amounts of data. This library needs Python version 3.9 or later. The full API docs can be found at [docs reference](https://xuri.me/excelize/).
6+
7+
- Source Code: [github.com/xuri/excelize-py](https://github.com/xuri/excelize-py)
8+
- Issue: [github.com/xuri/excelize-py/issues](https://github.com/xuri/excelize-py/issues)
9+
- PyPI: [pypi.org/project/excelize](https://pypi.org/project/excelize)
10+
- Licenses: [BSD 3-Clause](https://opensource.org/licenses/BSD-3-Clause)
11+
- Last version: [v0.0.4](https://github.com/xuri/excelize-py/releases/latest)
12+
- Document update time: June 29, 2025
13+
14+
## Project mission
15+
16+
The goal of Excelize is to create and maintain a Python language version of the Excel Document API to handle xlsx files that conform to the Office Open XML (OOXML) standard. With Excelize you can use Python to read and write MS Excel files.
17+
18+
## Why use Excelize
19+
20+
In some cases, we need to manipulate Excel documents through programs, such as: open to read existing Excel document content, create new Excel documents, generate new Excel documents based on existing documents (templates), insert images into Excel documents, charts Elements such as tables and sometimes need to implement these operations across platforms. Excelize can easily meet these needs.
21+
22+
If your company or product is using Excelize, welcome <a href="mailto: xuri.me@gmail.com?Subject=Please add our company in Excelize Introduction page&amp;Body=Hello%2C%20this%20is%20%3Cyour%20name%3E%20from%20%3Cyour%20company%20name%3E.%0AWe%20are%20using%20Excelize%20and%20will%20be%20proud%20to%20add%20our%20company%20name%20to%20Excelize%20Introduction%20page.%0APlease%20see%20attachment%20for%20our%20logo.%20%3CBe%20sure%20to%20include%20logo%20in%20attachment%3E%0A" title="send Logo via E-mail">send Logo</a> to us.
23+
24+
## Community
25+
26+
- [Facebook Group](https://www.facebook.com/groups/excelize)
27+
- [Google Group](https://groups.google.com/g/excelize)
28+
- [Stack Overflow](https://stackoverflow.com/questions/tagged/excelize)
29+
- [Slack Channel](https://join.slack.com/t/xuri/shared_invite/zt-eriqdkeo-wV04zcCdBiiZveFgY86Wzw)
30+
- [Gitter](https://gitter.im/excelize/community)
31+
- [Community on Telegram](https://t.me/excelize)
32+
- [Community on Discord](https://discord.gg/MWV8MBQGtv)
33+
- [Excelize Community on Microsoft Teams](https://teams.live.com/l/invite/FBA8aHkflqEj5SNzQM)
34+
- [Skype Community](https://join.skype.com/YW3OFS5QjYcV?source=qr-ios): <a href="../images/skype_group@2x.png" alt="Excelize Skype Community" target="_blank" target="_blank">join via QR Code</a>
35+
- [Line Community](http://line.me/ti/g/NFIjhfbP_g): <a href="../images/line_group@2x.png" alt="Excelize Line Community" target="_blank" target="_blank">join via QR Code</a>
36+
- [DingTalk Group ID](https://qr.dingtalk.com/action/joingroup?code=v1,k1,6tmzbBbJuQkGezVdHJjsHz29CZI9F49xeW+cvOaECtk=&_dt_no_comment=1&origin=11): `30047129` | <a href="../images/dingtalk_group@2x.png" alt="Excelize DingTalk Group" target="_blank" target="_blank">join via QR Code</a>
37+
- QQ Group ID: `1302058237` (Verification info: Excelize) | <a href="../images/qq_group@2x.png" alt="Excelize QQ Group ID" target="_blank" target="_blank">join via QR Code</a>
38+
- Excelize WeChat ID: `hixuri` (Verification info: Excelize) | <a href="../images/wechat_group@2x.png" alt="Excelize WeChat Community" target="_blank" target="_blank">join via QR Code</a>
39+
- WeCom Group (Verification info: Excelize): <a href="../images/wecom_group@2x.png" title="Excelize WeCom Group" target="_blank">join via QR Code</a>
40+
- Inflow Group ID: `4375928` | <a href="../images/inflow_group@2x.png" alt="Excelize Inflow Group" target="_blank" target="_blank">join via QR Code</a>
41+
42+
## Sponsor Excelize Development
43+
44+
If you are an individual user and have enjoyed the productivity of using Excelize, consider donating as a sign of appreciation - like buying me coffee once in a while, or support this project by becoming a sponsor.
45+
46+
<a href="https://github.com/sponsors/xuri" title="GitHub Sponsor" target="_blank"><img width="170" src="https://xuri.me/excelize/images/github_sponsor@2x.png" alt="GitHub Sponsor"></a> <a href="https://www.paypal.com/paypalme/xuri" title="Donate with Paypal" target="_blank"><img width="170" src="https://xuri.me/excelize/images/donate@2x.png" alt="Donate with Paypal"></a> <a href="https://opencollective.com/excelize" title="Become a Sponsor" target="_blank"><img height="61" src="https://xuri.me/excelize/images/opencollective.com@2x.png" alt="Become a Sponsor"></a> <a href="https://www.patreon.com/xuri" title="Support Excelize on Patreon" target="_blank"><img height="61" src="https://xuri.me/excelize/images/patreon.com@2x.png" alt="Support Excelize on Patreon"></a>
47+
48+
## Commercial Support
49+
50+
Let us help you reach the maximum potential of your app, to make working with Excel fun. Besides offering a completely free and open source package, we can also offer support on a commercial basis:
51+
52+
- Prioritize your issue
53+
54+
Having a bug ticket, a question or a feature request on our Github issue tracker that needs urgent attention? We are happy to give your ticket priority based on commercial support, contact us to get more details.
55+
56+
- Technical advisory services
57+
58+
Need help implementing Excelize in your application and you are on a shortage of technology or resources? We are happy to supercharge your imports and exports and can step in your team on an hourly-basis contract.
59+
60+
Please contact us by <a href="mailto: xuri.me@gmail.com">E-mail</a>.

0 commit comments

Comments
 (0)