0.1.1 Release

Release Description for PythonDocxAJM

Version: 0.1.1

Overview

This release introduces the PythonDocxAJM class, which provides essential functionalities for managing and manipulating DOCX files within the PythonDocxAJM project. The key features include error handling, configuration management, document saving, and logging.

Key Features:

1. PythonDocxAJM Class:

   • Attributes:
     • file_template_path: Path to the DOCX template file.
     • file_save_path: Path where the resultant DOCX file will be saved.
     • Document: Represents the DOCX document being manipulated.
     • _logger: Logger instance for the class.
     • _config: Configuration settings for the class.
   • Methods:
     • __init__: Initializes a new instance of the PythonDocxAJM class with the provided configuration and template paths.
     • save: Saves the current state of the document to the specified file path.

2. Error Handling:

   • _TemplateLockedError: Custom error class to handle scenarios where the template is locked or unavailable.

Instructions for Maintainers:

1. Initialization:

   • Ensure the appropriate DOCX template and save paths are provided during the initialization of the PythonDocxAJM class instance.
   • Example:

     doc_manager = PythonDocxAJM(template_path="path/to/template", save_path="path/to/save")

2. Saving Document:

   • Use the save method to save the current document state.
   • Example:

     doc_manager.save()

3. Error Handling:

   • Handle _TemplateLockedError to manage template-related exceptions.
   • Example:

     try:
         # some operation
     except _TemplateLockedError as e:
         print(f"Error: {e}")

Notes:

• Ensure logging is configured to capture important events and errors.
• Follow the project guidelines for updating configuration settings and document templates.

Thank you for using PythonDocxAJM. We look forward to your feedback and contributions!