Update docs #88
Merged
Update docs #88
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
klinga
approved these changes
Mar 25, 2024
There was a problem hiding this comment.
@charlottekostelic You took the documentation to entirely another level 👏
I'm looking forward to seeing these published and in action. I see a lot of mkdocs-material markdown syntax that I'm super curious to experience.
Have only a minor suggestions/questions.
| <Response [200]> | ||
| >>> print(result.json()) | ||
| with MetadataSession(authorization=token) as session: | ||
| response = session.brief_bibs_search(q="ti:The Power Broker AND au: Caro, Robert") |
There was a problem hiding this comment.
Interesting choice for a query 🚚 🚛 🚗 🚕 🚚 ...
| @@ -152,7 +152,7 @@ def _url_search_lbd(self) -> str: | |||
|
|
|||
| def bib_create( | |||
| self, | |||
| record: str, | |||
| record: Union[str, bytes, BinaryIO], | |||
There was a problem hiding this comment.
Were you able to confirm utf-8 encoded str that includes diacritical marks works with the API?
There was a problem hiding this comment.
bib_match and bib_validate work when passed a str but I still haven't tested bib_create or bib_replace.
| BookOps-Worldcat was glued together by [Tomasz Kalata](mailto:klingaroo@gmail.com) and [Charlotte Kostelic](mailto:charlottekostelic@gmail.com) with contributions by [Miriam Gloger](). |
There was a problem hiding this comment.
should we ask Miriam for her email?
| @@ -337,7 +337,7 @@ def bib_match( | |||
| def bib_replace( | |||
| self, | |||
| oclcNumber: Union[int, str], | |||
| record: str, | |||
| record: Union[str, bytes, BinaryIO], | |||
charlottekostelic
added a commit
that referenced
this pull request
Mar 26, 2024
* move cov & pytest config to pyproject.toml * remove temp file * remove pytest-recording * add py311 * dependencies updates * drop py3.7 * copy main config * drop py3.7 * add requests to dev dependencies * fix missing dependencies * dependencies final update * version bump to 1.0.0 * adds all dependencies * add py3.12 * typing cleanup & tests refactoring * Authentication updates (#69) * ingnore E501 in tests * add types-requests to dev dependencies * scopes as str * scopes as str & types cleanup * dev dependencies moved to tool.poetry.group.dev.dependencies section * token_expires_at as datetime obj * token_expires_at as datetime * changed utcnow to now(timezone.utc) (#71) * Ocn-parsing-refactor (#72) * prep_oclc_numbe_strr refactor * oclcNumber stripped * verification refactor * utc fixes (#73) * fixed datetime type errors * moved datetime edits to _hasten_expiration_time * Errors-refactor (#74) * removed WorldcatSessionError * incorrect AttributeError replaced with TypeError * replaces WorldcatAuthorizationError with TypeError and ValueError for configuration * removed unused WorldcatAuthorizationError import * removed unused WorldcatRequestError import * added safe decoding for bytes-str * ignore F401 * None type added to possible timeout types * added type ingnore * removed unused InvalidOclcNumber import & typing fixes * changed endpoints in metadata api 2.0 (#77) * changed endpoints in metadata api 2.0 * fixed tests with typos * changed response_format default in get_full_bib * Changed search endpoints (#78) * changed search endpoints in metadata api 2.0 * fixed types * fixed spacing and indentation * type hint fixes and refactored test * Removed principalID and principalIDNS from token requests (#79) * removed unnecessary params from token requests * fixed docstring * MetadataSession cleanup (#80) * reordered methods in MetadataSession * removed obsolete 409 error handling from query.py * simplified changes * added new api endpoints (#81) * added new api endpoints * added tests * added test * added to doc string, fixed typos (#82) @charlottekostelic This is something that should be brought to users attention in the documentation. Will create an issue as a reminder. Besides that, looks good. Thanks! * Query updates (#84) * work in progress * added retries to query * removed test with stale token * added stale token test back in * added stale token test back in * moved retries to _session module, added tests * added retry status_forcelist tests * added custom adapter test * changed default retry behavior * added another test * more testing * Reordered metadata methods (#85) * renamed/reordered metadata_api methods * fixed optional/required args, added to doc strings * fixed default values to match API defaults * fixed error in live test * dev status update to 5, removes py3.7 & adds py3.11 & py3.12 (#87) * Update docs (#88) * reorganized docs, added mkdocs-material theme * added css for NYPL colors * reorganized docs, added examples * changed structure of docs, added to docs * changed snake case to camel case in args * typo fixes * added contributing.md, python versions for black * added 1.0 to changelog, migration section in docs * Added migration section to README * typo fixes, link fixes * added py.typed file * fixed links, made edits per PR 88 * added mkdocstrings, removed mkapi, doc edits (#91) * edited changelog * pyproject.toml edits * update unit-tests.yaml * fixed unit-tests.yaml * unit-tests.yaml indentation issues --------- Co-authored-by: klinga <klingaroo@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changed:
MetadataSessionandWorldcatSessionto camel case (all args should now be in camel case per Camel case in methods' arguments #17)index.mdinto multiple files to allow for multiple pages on https://bookops-cat.github.io/bookops-worldcat (new pages listed below)readthedocs>materialtarget-versionfor black inpyproject.tomlAdded:
bytesandBytesIOas types forMetadataSessionmethods that send MARC record in request bodymkdocs-materialas dev-dependencyextra.cssto customize theme with NYPL colorsstart.md)search.md)manage_bibs.md)manage_holdings.md)local.md)advanced.md)contributing.md, there's still more to add here in a future PR)WorldcatAccessTokenper Required RegistryID in scopes context (API 2.0 - releases/v1.0.0) #83 (this is in the Advanced Usage > WorldcatAccessToken section)py.typedfile and updatedpyproject.tomlRemoved:
tutorials.md. The page is there as a placeholder and I will update it in a future PR.