Pythondocxajm

Latest version: v0.1.5

Safety actively analyzes 681812 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

0.1.5

0.1.4

trying to fix import issues AGAIN

0.1.3

fixed setup bug and init bug

0.1.2

minor bug fix

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:
python
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:
python
doc_manager.save()


3. **Error Handling**:
- Handle `_TemplateLockedError` to manage template-related exceptions.
- Example:
python
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!

0.1

Overview
This release includes important updates and improvements for the PythonDocxAJM project, ensuring better distribution management, streamlined project setup, and easier package uploads to PyPI.

Key Features:

1. **Setup Enhancement**:
- Introduced a robust setup process using `python -m build` to create source distributions (`sdist`).
- Validated and ensured the presence of crucial files (`LICENSE.txt`, `README.md`, `setup.cfg`, `setup.py`) for package consistency and compliance.

2. **Automated Distribution Upload**:
- Simplified the process of uploading package distributions to PyPI using `twine`.
- Enabled seamless uploads to PyPI with user authentication via token (`__token__`).
- Added instructions for uploading to TestPyPI for testing purposes with the `--repository` flag.

3. **Installation Instructions**:
- Provided clear guidelines for installing packages from TestPyPI using pip with the `--index-url` flag.

Instructions for Maintainers:

1. **Pre-upload Checklist**:
- Ensure all necessary files (`LICENSE.txt`, `README.md`, `setup.cfg`, `setup.py`) are updated.
- Commit changes to the remote repository.
- Create a new release tag on the remote repository.

2. **Running the Build and Upload**:
- Execute the build command to package the project:
sh
python -m build

- Upload the built distributions to PyPI using:
sh
twine upload dist/*


3. **Testing on TestPyPI**:
- Upload to TestPyPI (optional):
sh
twine upload --repository testpypi dist/*

Links

Releases

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.