release: prepare v1.0.0rc1 release

python-openxml · Oct 2, 2023 · 5b3ee80 · 5b3ee80
1 parent e47dfa2
commit 5b3ee80
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 18 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -3,6 +3,25 @@
 Release History
 ---------------
 
+1.0.0 (2023-10-01)
++++++++++++++++++++
+
+- Remove Python 2 support. Supported versions are 3.7+
+* Fix #85:   Paragraph.text includes hyperlink text
+* Add #1113: Hyperlink.address
+* Add Hyperlink.contains_page_break
+* Add Hyperlink.runs
+* Add Hyperlink.text
+* Add Paragraph.contains_page_break
+* Add Paragraph.hyperlinks
+* Add Paragraph.iter_inner_content()
+* Add Paragraph.rendered_page_breaks
+* Add RenderedPageBreak.following_paragraph_fragment
+* Add RenderedPageBreak.preceding_paragraph_fragment
+* Add Run.contains_page_break
+* Add Run.iter_inner_content()
+
+
 0.8.11 (2021-05-15)
 +++++++++++++++++++
 

diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+# python-docx
+
+*python-docx* is a Python library for reading, creating, and updating Microsoft Word 2007+ (.docx) files.
+
+## Installation
+
+```
+pip install python-docx
+```
+
+## Example
+
+```python
+>>> from docx import Document
+
+>>> document = Document()
+>>> document.add_paragraph("It was a dark and stormy night.")
+<docx.text.paragraph.Paragraph object at 0x10f19e760>
+>>> document.save("dark-and-stormy.docx")
+
+>>> document = Document("dark-and-stormy.docx")
+>>> document.paragraphs[0].text
+'It was a dark and stormy night.'
+```
+
+More information is available in the [python-docx documentation](https://python-docx.readthedocs.org/en/latest/)
diff --git a/README.rst b/README.rst
diff --git a/pyproject.toml b/pyproject.toml
@@ -21,13 +21,14 @@ classifiers = [
     "Topic :: Software Development :: Libraries",
 ]
 dependencies = [
-    "lxml>=2.3.2",
+    "lxml>=3.1.0",
+    "typing_extensions",
 ]
 description = "Create, read, and update Microsoft Word .docx files."
 dynamic = ["version"]
 keywords = ["docx", "office", "openxml", "word"]
 license = { text = "MIT" }
-readme = "README.rst"
+readme = "README.md"
 requires-python = ">=3.7"
 
 [project.urls]

diff --git a/requirements-test.txt b/requirements-test.txt
@@ -3,4 +3,3 @@ behave>=1.2.3
 pyparsing>=2.0.1
 pytest>=2.5
 ruff
-typing-extensions
diff --git a/requirements.txt b/requirements.txt
@@ -1 +1,2 @@
 lxml>=3.1.0
+typing-extensions
diff --git a/tox.ini b/tox.ini
@@ -2,11 +2,7 @@
 envlist = py37, py38, py39, py310, py311
 
 [testenv]
-deps =
-    behave
-    lxml
-    pyparsing
-    pytest
+deps = -rrequirements-test.txt
 
 commands =
     py.test -qx