Skip to content
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.

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

Release v1.1.0 #119

Merged
merged 8 commits into from
Dec 4, 2024
Merged

Release v1.1.0 #119

merged 8 commits into from
Dec 4, 2024

Conversation

charlottekostelic
Copy link
Contributor

Added

  • Support for new Metadata API functionality:
    • bib_search method within MetadataSession class allows users to retrieve full MARC records in JSON format with the new /worldcat/search/bibs/{oclcNumber}
    • cascadeDelete arg added to holdings_unset and holdings_unset_with_bib methods. LHR and LBD records will be deleted when unsetting holdings on a record in WorldCat. This default functionality can be changed by setting cascadeDelete to False
  • Monthly live tests running via GitHub Actions
    • Tests will check whether changes have been made to the Metadata API
  • Python 3.13 added to unit tests
  • Type annotations added to fixtures in conftest.py
  • scope added as a return value in WorldcatAccessToken tests and documentation
    • OCLC's Authorization Server now accepts and returns scope as a parameter but it appears to be interchangeable with scopes. It is listed in the tests and documentation for WorldcatAccessToken but is not included as an attribute for the class.
  • Dev dependencies:
    • types-pyyaml (6.0.12)

Changed

  • Moved live tests to separate files within tests/webtests directory
  • Moved fixtures for live tests to tests/webtests/conftest.py
  • Minor edits to tests due to changes in responses from Metadata API
  • Updated dependencies:
    • certifi (2024.8.30)
    • charset-normalizer (3.4.0)
    • idna (3.10)
    • requests (2.32.3)
    • urllib3 (2.2.3)
  • Updated dev dependencies:
    • babel (2.16.0)
    • black (24.8.0)
    • coverage (7.6.1)
    • exceptiongroup (1.2.2)
    • griffe (1.4.0)
    • importlib-metadata (8.5.0)
    • importlib-resources (6.4.5)
    • jinja2 (3.1.4)
    • markdown (3.7)
    • mike (2.1.3)
    • mkdocs-autorefs (1.2.0)
    • mkdocs-get-deps (0.2.0)
    • mkdocs-material (9.5.44)
    • mkdocs (1.6.1)
    • mkdocstrings-python (1.10.0)
    • mkdocstrings (0.24.3)
    • mypy (1.13.0)
    • packaging (24.2)
    • paginate (0.5.7)
    • platformdirs (4.3.6)
    • pluggy (1.5.0)
    • pygments (2.18.0)
    • pymdown-extensions (10.12)
    • pyparsing (3.1.4)
    • pytest-mock (3.14.0)
    • python-dateutil (2.9.0.post0)
    • pytz (2024.2)
    • pyyaml (6.0.2)
    • regex (2024.11.6)
    • tomli (2.1.0)
    • types-requests (2.32.0.20241016)
    • typing-extensions (4.12.2)
    • urllib3 (2.2.3)
    • watchdog (4.0.2)
    • wheel (0.45.0)
    • zipp (3.20.2)

Fixed

  • Return type for all MetadataSession methods is now requests.Response not Optional[requests.Response]
  • Typos and incorrect import statements

Removed

  • Redundant/unused fixtures for mock 400 and 409 responses from conftest.py
  • Changed stub_marc21 fixture to return bytes and removed test.mrc file

* updated dependencies and version

* updated WorldcatAccessToken with scope/scopes
changes

* updated changelog and advanced docs added test
* added ignore flake8 F401 for test_bookops_worldcat

* added types-pyyaml as dev dependency

* added type annotations removed unnecessary imports

* deleted test.mrc as it is now redundant

* fixed typo in import statement

* exported updated dev-requirements.txt

* added 3.13 to unit-tests.yaml

* fixed live_keys fixture for GITHUB_ACTIONS
* added bib_search method to MetadataSession class

* added section on /search/bibs/ endpoint to docs

* fixed return type for bib_search method
* added cascadeDelete arg to holdings_unset methods

* updated docs to reflect holdings unset changes
* added yaml file for monthly live test gh action

* added additional webtest for WorldcatAccessToken

* updated contributing.md with info about live tests

* added fixtures for live tests and monthly checks

* separated live tests into two classes

* renamed, simplified endpoint_params fixture

* reviewing changes to MetadataSession webtests

* moved webtests to separate files and directory

* created separate conftest for webtests

* fixed typos in conftest docstrings

* separated webtests into different classes

* updated monthly test schedule

* added additional type annotations to conftest.py

* updated live_keys fixture for posix and windows

* updated triggers in monthly-api-tests.yaml

* moved live_keys fixture to webtests/conftest.py

* changed triggers for webtest workflow

* fixed typo in conditionals

* changed live_token fixture scope to reduce calls

* added automatic retries to holdings tests
* updated version in __version__.py

* updated changelog for version 1.1.0

* fixed date in changelog

* updated release checklist and contribution guide

* changed package version, added python 3.13

* updated all dependencies

* added additional dependency updates to changelog

* added link to detailed code changes in changelog

* fixed failing test due to change in api response
Copy link
Member

@klinga klinga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, Charlotte!
Nice work.

@charlottekostelic charlottekostelic merged commit d3fb22b into main Dec 4, 2024
24 checks passed
@charlottekostelic charlottekostelic deleted the releases/v1.1.0 branch December 4, 2024 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants