Almapi wrapper documentation

This python module is a tool to use Alma APIs. it manages the logs and the backup of the records.

• Author: Raphaël Rey (raphael.rey@slsp.ch)

• Year: 2026

• Version: 1.7.6

• License: GNU General Public License v3.0

Introduction

How to import modules

# Import libraries
from almapiwrapper.users import User, NewUser, fetch_users, fetch_user_in_all_iz, Fee, Loan, Request, check_synchro, force_synchro
from almapiwrapper.inventory import IzBib, NzBib, Holding, Item, Collection
from almapiwrapper.config import RecSet, ItemizedSet, LogicalSet, NewLogicalSet, NewItemizedSet, Job, Library, Location, Desk, fetch_libraries
from almapiwrapper.config import Reminder, Library, Location, OpenHours, Department
from almapiwrapper.config import fetch_reminders, fetch_departments, fetch_libraries
from almapiwrapper.record import JsonData, XmlData
from almapiwrapper.analytics import AnalyticsReport
from almapiwrapper.acquisitions import POLine, Vendor, Invoice, fetch_invoices
from almapiwrapper.configlog import config_log
from almapiwrapper import ApiKeys

# Config logs
config_log()

Contents

• Get started
• Tests

Module Almapi

• Inventory submodule
  • IzBib class
  • NzBib class
  • Holding class
  • Item class
  • Collection class
• Acquisitions submodule
  • POLine class
  • Vendor class
• Users submodule
  • User class
  • NewUser class
  • Fee class
  • Loan class
  • Request class
  • Fetch_users function
  • fetch_user_in_all_iz function
  • check_synchro function
  • force_synchro function
• Config submodule
  • Desk class
  • Department class
  • Job class
  • Library class
  • Location class
  • LogicalSet class
  • ItemizedSet class
  • NewLogicalSet class
  • NewItemizedSet class
  • Reminder class
• AnalyticsReport class
• ApiKeys class
• config_log function
• JsonData class
• XmlData class

Indices and tables

• Index