Skip to content

Version 0.7.0 #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
daniel-tran merged 9 commits into from
Jan 25, 2023
Merged

Version 0.7.0 #15

daniel-tran merged 9 commits into from
Jan 25, 2023

Conversation

@daniel-tran
Copy link
Owner

@daniel-tran daniel-tran commented Jan 22, 2023

  • XML Downloader and Extractor now work with a different XML structure. Most notably, it uses more generic tag names such as <book>, <chapter> and <passage>.
    • Previously, passages would be tagged as different nodes and the overall structure between downloaded files would technically be different per-book due to the XML tag name standardisation logic.
  • Added Timestamp and Meaningless fields to downloader-generated files.
    • Timestamp can be useful for determining when the wording of a particular passage may have changed on the Bible Gateway.
    • Meaningless can be useful for troubleshooting potential regressions between a particular library version and an input file generated by a previous version.

Minor changes include:

  • Dropping support for Python 3.7

@daniel-tran
Initial rework of XML file interface
1822153 
To make it easier to use generated XML files in external applications and XSLT. Still keeping the original XML file interface for backwards compatibility, though that won't always be the case in future releases.
@daniel-tran
Add Timestamp and Meaningless fields to Info section
d7f262a 
Also refining the CSV file interface to be more flexible when handling metadata information and not cause a bunch of unit tests to fail just because a new column is available
@daniel-tran
Drop support for Python 3.7
4ebf5dd
@daniel-tran
Add legacy XML file interface to documentation
9894562 
Also adding the library version to the main index page, since this information is never explicitly mentioned anywhere
@daniel-tran
Update library version source in setup script
ff76f65 
With the common utilities submodule providing a function to get the library version, a dedicated file for this information is no longer needed
@daniel-tran
Avoid using filecmp in Base Downloader unit tests
fb38e1f 
Tests can currently fail due to the timestamp not being exactly the same, so just check for the main passage contents
@daniel-tran
Add legacy XML file interface unit tests to workflow
7f8dc90
@daniel-tran
Document default ways to roll out breaking changes
c6753cc 
Also updating the example dictionary structure with the Timestamp and Meaningless properties
@daniel-tran
Update informational files with current changes in 0.7.0
352ec5b
@daniel-tran daniel-tran added the new release Collating all the changes for a new version label Jan 22, 2023
@daniel-tran daniel-tran merged commit 36605f2 into master Jan 25, 2023
@daniel-tran daniel-tran deleted the 0.7.0 branch January 25, 2023 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

new release Collating all the changes for a new version

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@daniel-tran