- pynlb
- Introduction
- System Overview
- User Personas
- Prerequisites
- Installation and Configuration
- Execution
- Troubleshooting and FAQs
- Reference
This document describes the pynlb
library and companion CLI that interact with National Library Board (NLB) API endpoints that are provided for DevSecOps, Developers and CLI Users.
The audience for this document includes:
-
User who will install and configure
pynlb
on their workstation to query the NLB catalog. -
Developer who will implement, build, test all commands within the
pynlb
library and companion CLI. -
DevSecOps who will configure and maintain CI/CD pipelines to automate the build process.
- This wrapper abstracts away the complexity of interacting with the NLB API endpoints by providing a Python library
pynlb
and companion command-line interface (CLI).
This project uses several methods and products to optimize your workflow.
- Use a version control system (GitHub) to track your changes and collaborate with others.
- Use a static analyzer (prospector) to help write your clean code.
- Use a build tool (Makefile) to automate your development tasks.
- Use a package manager (Pipenv) to manage your dependencies.
- Use a testing framework (pytest) to automate your testing.
- Use a containerization platform (Docker) to run your application in any environment.
- Use a continuous integration pipeline (CircleCI) to automate your static analysis and image deployment.
- Use an artifactory (Docker Hub) to store and pull your image.
Category | Activity | User | Developer | DevSecOps |
---|---|---|---|---|
Prerequisites | Request and obtain an API key | R,A | I | |
Installation & Configuration | Create a virtual environment | R,A | ||
Installation & Configuration | Create a Makefile | R,A |
The following resources are used as a single-use reference.
Title | Author | Published Date |
---|---|---|
How good is our latest Singapore Library APIs? An Honest Review | Cliff Chew | 26-Aug-2023 |
GitHub yi-jiayu/nlbsg | Jiayu Yi | 31-Aug-2023 |
NLBlabs | NLB | 31-Aug-2023 |