python-openxml · BayooG · Feb 25, 2019 · Feb 26, 2019 · Feb 27, 2019 · Feb 28, 2019
diff --git a/.github/workflows/pythonpublish.yml b/.github/workflows/pythonpublish.yml
@@ -0,0 +1,31 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Publish on PYPI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,8 @@
 _scratch/
 Session.vim
 /.tox/
+/build/
+/tests/
+/features/
+/docs/
+/ref/
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -0,0 +1,14 @@
+## Bayoo-docx contributors
+
+============================================
+
+* **[Obay Daba](https://github.com/bayoog)**
+
+* **[Bassel Al Madani](https://github.com/pepos9)**
+
+* **[Tareq Ibrahim](https://github.com/idtareq)**
+
+* **[baltazarix](https://github.com/baltazarix)**
+
+* **[Ahmad Alwareh](https://github.com/ahmadalwareh)**
+
diff --git a/DESCRIPTION.rst b/DESCRIPTION.rst
@@ -0,0 +1,42 @@
+Bayoo-docx
+
+
+Python library forked from  `python-docx <github.com/python-openxml/python-docx/>`_.
+
+The main purpose of the fork was to add implementation for comments and footnotes to the library
+
+Installation
+
+
+Use the package manager `pip <pypi.org/project/bayoo-docx/>`_ to install bayoo-docx.
+
+
+`pip install bayoo-docx`
+
+Usage
+
+
+::
+
+    import docx
+
+    document = docx.Document()
+
+    paragraph1 = document.add_paragraph('text') # create new paragraph
+
+    comment = paragraph.add_comment('comment',author='Obay Daba',initials= 'od') # add a comment on the entire paragraph
+
+    paragraph2 = document.add_paragraph('text') # create another paragraph
+
+    run = paragraph2.add_run('texty') add a run to the paragraph
+
+    run.add_comment('comment') # add a comment only for the run text 
+
+    paragraph.add_footnote('footnote text') # add a footnote
+
+
+
+License
+
+
+`MIT <https://choosealicense.com/licenses/mit/>`_
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -1,264 +1,24 @@
 .. :changelog:
 
-Release History
----------------
 
-0.8.10 (2019-01-08)
-+++++++++++++++++++
+#Release History BayooG/bayoo-docx forked from (python-openxmm/python-docx)
 
-- Revert use of expanded package directory for default.docx to work around setup.py
-  problem with filenames containing square brackets.
 
+0.2.8 (2020-05-02)
 
-0.8.9 (2019-01-08)
-++++++++++++++++++
+- add comments implementation on a run level
+- fix issue with comments date (comments dates are set to current date)
 
-- Fix gap in MANIFEST.in that excluded default document template directory
 
+0.2.4 (2019-9-4)
 
-0.8.8 (2019-01-07)
-++++++++++++++++++
+- loop over all the document chieldern (Paragraphs, Tables, Sections) with the right order `document.elements`
+- addons to Paragraph Object (delete, heading_level, merge_paragraph )
+- Add low-level implementation for comments part
+- Add oxml element for <w:comments> element and sub-elements
+- Add add_comment() method for docx.text.Paragraph 
+- Add low-level implementation for footnotes part
+- Add oxml element for <w:footnotes> element and sub-elements
+- Add add_footnote() method for docx.text.Paragraph 
 
-- Add support for headers and footers
 
-
-0.8.7 (2018-08-18)
-++++++++++++++++++
-
-- Add _Row.height_rule
-- Add _Row.height
-- Add _Cell.vertical_alignment
-- Fix #455: increment next_id, don't fill gaps
-- Add #375: import docx failure on --OO optimization
-- Add #254: remove default zoom percentage
-- Add #266: miscellaneous documentation fixes
-- Add #175: refine MANIFEST.ini
-- Add #168: Unicode error on core-props in Python 2
-
-
-0.8.6 (2016-06-22)
-++++++++++++++++++
-
-- Add #257: add Font.highlight_color
-- Add #261: add ParagraphFormat.tab_stops
-- Add #303: disallow XML entity expansion
-
-
-0.8.5 (2015-02-21)
-++++++++++++++++++
-
-- Fix #149: KeyError on Document.add_table()
-- Fix #78: feature: add_table() sets cell widths
-- Add #106: feature: Table.direction (i.e. right-to-left)
-- Add #102: feature: add CT_Row.trPr
-
-
-0.8.4 (2015-02-20)
-++++++++++++++++++
-
-- Fix #151: tests won't run on PyPI distribution
-- Fix #124: default to inches on no TIFF resolution unit
-
-
-0.8.3 (2015-02-19)
-++++++++++++++++++
-
-- Add #121, #135, #139: feature: Font.color
-
-
-0.8.2 (2015-02-16)
-++++++++++++++++++
-
-- Fix #94: picture prints at wrong size when scaled
-- Extract `docx.document.Document` object from `DocumentPart`
-
-  Refactor `docx.Document` from an object into a factory function for new
-  `docx.document.Document object`. Extract methods from prior `docx.Document`
-  and `docx.parts.document.DocumentPart` to form the new API class and retire
-  `docx.Document` class.
-
-- Migrate `Document.numbering_part` to `DocumentPart.numbering_part`. The
-  `numbering_part` property is not part of the published API and is an
-  interim internal feature to be replaced in a future release, perhaps with
-  something like `Document.numbering_definitions`. In the meantime, it can
-  now be accessed using ``Document.part.numbering_part``.
-
-
-0.8.1 (2015-02-10)
-++++++++++++++++++
-
-- Fix #140: Warning triggered on Document.add_heading/table()
-
-
-0.8.0 (2015-02-08)
-++++++++++++++++++
-
-- Add styles. Provides general capability to access and manipulate paragraph,
-  character, and table styles.
-
-- Add ParagraphFormat object, accessible on Paragraph.paragraph_format, and
-  providing the following paragraph formatting properties:
-
-  + paragraph alignment (justfification)
-  + space before and after paragraph
-  + line spacing
-  + indentation
-  + keep together, keep with next, page break before, and widow control
-
-- Add Font object, accessible on Run.font, providing character-level
-  formatting including:
-
-  + typeface (e.g. 'Arial')
-  + point size
-  + underline
-  + italic
-  + bold
-  + superscript and subscript
-
-The following issues were retired:
-
-- Add feature #56: superscript/subscript
-- Add feature #67: lookup style by UI name
-- Add feature #98: Paragraph indentation
-- Add feature #120: Document.styles
-
-**Backward incompatibilities**
-
-Paragraph.style now returns a Style object. Previously it returned the style
-name as a string. The name can now be retrieved using the Style.name
-property, for example, `paragraph.style.name`.
-
-
-0.7.6 (2014-12-14)
-++++++++++++++++++
-
-- Add feature #69: Table.alignment
-- Add feature #29: Document.core_properties
-
-
-0.7.5 (2014-11-29)
-++++++++++++++++++
-
-- Add feature #65: _Cell.merge()
-
-
-0.7.4 (2014-07-18)
-++++++++++++++++++
-
-- Add feature #45: _Cell.add_table()
-- Add feature #76: _Cell.add_paragraph()
-- Add _Cell.tables property (read-only)
-
-
-0.7.3 (2014-07-14)
-++++++++++++++++++
-
-- Add Table.autofit
-- Add feature #46: _Cell.width
-
-
-0.7.2 (2014-07-13)
-++++++++++++++++++
-
-- Fix: Word does not interpret <w:cr/> as line feed
-
-
-0.7.1 (2014-07-11)
-++++++++++++++++++
-
-- Add feature #14: Run.add_picture()
-
-
-0.7.0 (2014-06-27)
-++++++++++++++++++
-
-- Add feature #68: Paragraph.insert_paragraph_before()
-- Add feature #51: Paragraph.alignment (read/write)
-- Add feature #61: Paragraph.text setter
-- Add feature #58: Run.add_tab()
-- Add feature #70: Run.clear()
-- Add feature #60: Run.text setter
-- Add feature #39: Run.text and Paragraph.text interpret '\n' and '\t' chars
-
-
-0.6.0 (2014-06-22)
-++++++++++++++++++
-
-- Add feature #15: section page size
-- Add feature #66: add section
-- Add page margins and page orientation properties on Section
-- Major refactoring of oxml layer
-
-
-0.5.3 (2014-05-10)
-++++++++++++++++++
-
-- Add feature #19: Run.underline property
-
-
-0.5.2 (2014-05-06)
-++++++++++++++++++
-
-- Add feature #17: character style
-
-
-0.5.1 (2014-04-02)
-++++++++++++++++++
-
-- Fix issue #23, `Document.add_picture()` raises ValueError when document
-  contains VML drawing.
-
-
-0.5.0 (2014-03-02)
-++++++++++++++++++
-
-- Add 20 tri-state properties on Run, including all-caps, double-strike,
-  hidden, shadow, small-caps, and 15 others.
-
-
-0.4.0 (2014-03-01)
-++++++++++++++++++
-
-- Advance from alpha to beta status.
-- Add pure-python image header parsing; drop Pillow dependency
-
-
-0.3.0a5 (2014-01-10)
-++++++++++++++++++++++
-
-- Hotfix: issue #4, Document.add_picture() fails on second and subsequent
-  images.
-
-
-0.3.0a4 (2014-01-07)
-++++++++++++++++++++++
-
-- Complete Python 3 support, tested on Python 3.3
-
-
-0.3.0a3 (2014-01-06)
-++++++++++++++++++++++
-
-- Fix setup.py error on some Windows installs
-
-
-0.3.0a1 (2014-01-05)
-++++++++++++++++++++++
-
-- Full object-oriented rewrite
-- Feature-parity with prior version
-- text: add paragraph, run, text, bold, italic
-- table: add table, add row, add column
-- styles: specify style for paragraph, table
-- picture: add inline picture, auto-scaling
-- breaks: add page break
-- tests: full pytest and behave-based 2-layer test suite
-
-
-0.3.0dev1 (2013-12-14)
-++++++++++++++++++++++
-
-- Round-trip .docx file, preserving all parts and relationships
-- Load default "template" .docx on open with no filename
-- Open from stream and save to stream (file-like object)
-- Add paragraph at and of document
diff --git a/LICENSE b/LICENSE
@@ -1,5 +1,6 @@
 The MIT License (MIT)
-Copyright (c) 2013 Steve Canny, https://github.com/scanny
+Copyright (c) 2019 Obay Daba, https://github.com/bayoog 
+forked from https://github.com/python-openxml/python-docx
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal