lib-holdings-simplified 1.2.0

CLI tool for retrieving holding counts for a list of OCNs and libraries, simplified version

lib-holdings

Based on the https://pypi.org/project/lib-holdings/ Copyright (c) 2024 Max Paulus

Command Line Interface (CLI) tool for retrieving holding counts for a list of OCNs and institutes.

Uses the OCLC API: https://developer.api.oclc.org/

Simplied version which only uses the "wcapi"-scope

Installation

First of all, you will need to have Python installed on your computer and available on the command line. If this sounds scary, consider installing the Anaconda Navigator, an application that comes with Python and a command line.

Once installed, find and run the Anaconda Prompt which is the command line interface.

Again, knowing the command line is not a requirement. Simply copy the following into the window and press enter:

pip install --upgrade lib-holdings-simplified 

After the tool has been installed, continue below to learn how it works.

Usage

Preparation

Make sure you have the two input files ready:

1. A text file (e.g. .txt) containing OCNs with 1 OCN per line
2. A text file (e.g. .txt) containing institute symbols with 1 symbol per line

It is recommended to create a folder on your computer in which you place these input files.

Note down the path to this folder, e.g. C:/Users/username/myfolder (on Windows).

Execute the following command, replacing PATH with your path:

cd PATH

The command line now has access to that folder.

Create an empty folder (e.g. out) in which the results will be stored.

Also, keep your API key and secret handy.

Run the program

Copy and execute the following command, after replacing the indicated arguments.

(Description of the arguments can be found below)

holdings [OPTIONS] INFILE_OCNS INFILE_SYMB OUT_FOLDER

ARGUMENTS:

INFILE_OCNS:    name of the text file containing OCNs (1 per line)
INFILE_SYMB:    name of the text file containing institute symbols (1 per line)
OUT_FOLDER:     output directory

OPTIONS:

--start INTEGER  Position of OCN to start with.
--key TEXT       OCLC API key.
--secret TEXT    OCLC API secret.
--details BOOL   Use the detaild search or not (default =  True)

Note:

The start option is handy when the program is interrupted or exits with an error. In that case, you can re-run the program, providing the start value shown.

The details option determines which of the URLs is used:

• True = https://americas.discovery.api.oclc.org/worldcat/search/v2/bibs-detailed-holdings
• False = https://americas.discovery.api.oclc.org/worldcat/search/v2/bibs-holdings

Changes

To make a new versions of the package and deploy it to

https://pypi.org/project/lib-holdings-simplified/

see:

https://packaging.python.org/en/latest/tutorials/packaging-projects/

Short step-by-step instructions

• Apply any changes and test locally
• Remove previous package builds from the /dist-folder
• Get the build-package: python3 -m pip install --upgrade build
• Edit pyproject.toml and change the name to 'lib-holdings-simplified-test' and the version.
• Build the distribution: python3 -m build
• Check created distributions in the 'dist'-folder for the correct version number
• Get the twine-package: python3 -m pip install --upgrade twine
• Upload to test repository: python3 -m twine upload --repository testpypi dist/*
• Test in test-application with python3 -m pip install --upgrade --index-url https://test.pypi.org/simple/ --no-deps lib-holdings-simplified
• If all ok:
  • Remove test builds from the /dist-folder
  • Change back name and set correct version in pyproject.toml
  • Create finale distribution with python3 -m build
  • Upload to real repository: python3 -m twine upload dist/*

Changelog

V 1.0.1

In __main__.py

Regels 45-47: skip transform_records and merge

Lines 68: function transform_records() is no longer used.

In api.py

Line 43: function extract_record_type() is no longer used

V 1.1.0

In api.py

Line 9: Add scope as extra parameter to init function.

Line 11: removed ‘WMS_COLLECTION_MANAGEMENT’ scope.

V 1.2.0

Added '--details'-option