Merge pull request #11 from shcherbak-ai/dev

Refactored DOCX converter internals for better maintainability. Updated README. Added CHANGELOG.

Author: SergiiShcherbak

CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+All notable changes to ContextGem will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), with the following additional categories:
+
+- **Refactor**: Code reorganization that doesn't change functionality but improves structure or maintainability
+
+## [0.2.2](https://github.com/shcherbak-ai/contextgem/releases/tag/v0.2.2) - 2025-05-02
+### Refactor
+- Refactored DOCX converter internals for better maintainability
+
+## [0.2.1](https://github.com/shcherbak-ai/contextgem/releases/tag/v0.2.1) - 2023-04-30
+### Fixed
+- Fixed litellm dependency issue, pinning to version ==1.67.1 to avoid encoding bug in newer versions of litellm
+
+## [0.2.0](https://github.com/shcherbak-ai/contextgem/releases/tag/v0.2.0) - 2023-04-21
+### Added
+- Added DocxConverter for converting DOCX files into ContextGem Document objects

README.md

@@ -16,6 +16,7 @@
 [![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-blue?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
+[![Reddit](https://img.shields.io/badge/Reddit-Community-FF4500?logo=reddit&logoColor=white)](https://reddit.com/r/ContextGem)
 
 <img src="https://contextgem.dev/_static/tab_solid.png" alt="ContextGem: 2nd Product of the week" width="250">
 <br/><br/>
@@ -340,6 +341,8 @@ A raw text version of the full documentation is available at [`docs/docs-raw-for
 
 If you have a feature request or a bug report, feel free to [open an issue](https://github.com/shcherbak-ai/contextgem/issues/new) on GitHub. If you'd like to discuss a topic or get general advice on using ContextGem for your project, start a thread in [GitHub Discussions](https://github.com/shcherbak-ai/contextgem/discussions/new/).
 
+Join our [Reddit community](https://reddit.com/r/ContextGem) to connect with other users, share your projects, ask questions, and participate in discussions about ContextGem.
+
 
 ## 🤝 Contributing
 

contextgem/__init__.py

@@ -20,7 +20,7 @@
 ContextGem - Effortless LLM extraction from documents
 """
 
-__version__ = "0.2.1"
+__version__ = "0.2.2"
 __author__ = "Shcherbak AI AS"
 
 from contextgem.public import (

contextgem/internal/__init__.py

@@ -28,6 +28,15 @@
     _PostInitCollectorMixin,
     _RefParasAndSentsAttrituteProcessor,
 )
+from contextgem.internal.converters import (
+    WORD_XML_NAMESPACES,
+    DocxContentError,
+    DocxConverterError,
+    DocxFormatError,
+    DocxXmlError,
+    _DocxConverterBase,
+    _DocxPackage,
+)
 from contextgem.internal.data_models import (
     _LLMCall,
     _LLMCost,
@@ -155,4 +164,13 @@
     "_is_json_serializable",
     "_get_sat_model",
     "_setup_jinja2_template",
+    # Converters
+    # DOCX
+    "WORD_XML_NAMESPACES",
+    "DocxContentError",
+    "DocxConverterError",
+    "DocxFormatError",
+    "DocxXmlError",
+    "_DocxConverterBase",
+    "_DocxPackage",
 ]

contextgem/internal/converters/__init__.py

@@ -0,0 +1,37 @@
+#
+# ContextGem
+#
+# Copyright 2025 Shcherbak AI AS. All rights reserved. Developed by Sergii Shcherbak.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from contextgem.internal.converters.docx import (
+    WORD_XML_NAMESPACES,
+    DocxContentError,
+    DocxConverterError,
+    DocxFormatError,
+    DocxXmlError,
+    _DocxConverterBase,
+    _DocxPackage,
+)
+
+__all__ = [
+    "WORD_XML_NAMESPACES",
+    "DocxConverterError",
+    "DocxFormatError",
+    "DocxXmlError",
+    "DocxContentError",
+    "_DocxConverterBase",
+    "_DocxPackage",
+]

contextgem/internal/converters/docx/__init__.py

@@ -0,0 +1,37 @@
+#
+# ContextGem
+#
+# Copyright 2025 Shcherbak AI AS. All rights reserved. Developed by Sergii Shcherbak.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from contextgem.internal.converters.docx.base import _DocxConverterBase
+from contextgem.internal.converters.docx.exceptions import (
+    DocxContentError,
+    DocxConverterError,
+    DocxFormatError,
+    DocxXmlError,
+)
+from contextgem.internal.converters.docx.namespaces import WORD_XML_NAMESPACES
+from contextgem.internal.converters.docx.package import _DocxPackage
+
+__all__ = [
+    "_DocxConverterBase",
+    "DocxConverterError",
+    "DocxFormatError",
+    "DocxXmlError",
+    "DocxContentError",
+    "WORD_XML_NAMESPACES",
+    "_DocxPackage",
+]