Add PublishableEntities and PublishableEntityVersions to lp_dump file

[dwong2708]

Resolves: #332

Description

This PR introduces the following changes:

• Added a zipper.py module to handle all ZIP file–related operations.
• Introduced the TOMLPublishableEntityFile class to abstract TOML file generation for a publishable entity.
• Introduced the TOMLPublishableEntityVersionFile class to abstract TOML file generation for a publishable entity version.
• Added the TOMLMixin class to encapsulate and reuse common TOML-related methods.
• Improved the structure of the generated TOML files to better meet the requirements.
• Added a unit test to verify the expected structure and content of the dump file.

Resulting Dump File

Suggestion

Given the entity key xblock.v1:html:Query Counting, the TOML file currently uses this string as-is, which isn't ideal for a filename.
I suggest transforming it into a slugified format—for example: xblock-v1-html-query-counting—to make it more suitable as a filename.

Content of the Entity File

[openedx-webhooks]

Thanks for the pull request, @dwong2708!

This repository is currently maintained by @axim-engineering.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

---

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[Copilot]

Pull Request Overview

This PR adds functionality to dump learning packages with their publishable entities to a ZIP file containing TOML representations. The implementation introduces a modular architecture for ZIP file creation and TOML generation.

• Added ZIP file creation with publishable entities as individual TOML files
• Introduced a mixin pattern for TOML generation with reusable components
• Created comprehensive test coverage for the dump functionality

Reviewed Changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
openedx_learning/apps/authoring/backup_restore/zipper.py	New module implementing ZIP file creation with learning package and entity data
openedx_learning/apps/authoring/backup_restore/toml.py	Added TOMLPublishableEntityFile class and TOMLMixin for reusable TOML generation
openedx_learning/apps/authoring/backup_restore/api.py	Refactored to use new zipper module instead of inline ZIP creation
openedx_learning/apps/authoring/backup_restore/management/commands/lp_dump.py	Removed redundant logging in exception handler
openedx_learning/apps/authoring/publishing/models/publishable_entity.py	Added can_stand_alone property to PublishableEntityVersioning
tests/openedx_learning/apps/authoring/backup_restore/test_backup.py	New comprehensive test suite for backup functionality
test_settings.py	Added BackupRestoreConfig to installed apps
openedx_learning/api/authoring.py	Exposed backup_restore API functions

[dwong2708]

Hi @ormsbee. I’m done with this task. Please let me know if it meets the requirements when you have a chance

[ormsbee]

It's not a blocker for this PR, but I'm not clear on why it's necessary to create mixins and classes for the TOML conversion of the data. It seems like it would be simpler to declare them as simple functions that take what the constructor took and returns the TOML document object.

[ormsbee]

I'm not clear on why this class exists. These small methods only seem to echo into the TOMLDocument object?

[dwong2708]

Basically yes. The idea was to act as a sort of interface (it didn’t quite work out that way, but that was the intention) in case we ever wanted to switch from TOML to YAML or another format. However, I agree with you—keeping it simple is better. I don't think we'll need to support other formats, so I can convert this into simple functions.

[dwong2708]

It was changed to functions

[ormsbee]

Is this equivalent to:

section = table()
section.update(params)

?

[dwong2708]

I didn't know about this method. I'll change it. Thanks Dave.