Package Health Score

78 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Popularity

Small

GitHub Stars: 119
Forks: 31
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package ocrd, we found that it has been starred 119 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Oct 10, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like ocrd is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 117
Open PR: 21
Last Release: 1 month ago
Last Commit: 1 month ago

Further analysis of the maintenance status of ocrd based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that ocrd demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the ocrd repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like ocrd is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.8

Age: 7 years
Latest Release: 5 days ago
Dependencies: 16 Direct
Versions: 236
Maintainers: 3
Wheels: OS Independent

Not sure how to use ocrd?

To help you get started, we've collected the most common ways that ocrd is being used within popular public projects.

OCR-D / core / tests / test_decorators.py View on Github

@ocrd_cli_options
def cli_param_dumper(*args, **kwargs):      # pylint: disable=unused-argument
    print(json.dumps(kwargs['parameter']))

View more ways to use ocrd

OCR-D/core

> Python modules implementing OCR-D specs and related tools

Introduction

This repository contains the python packages that form the base for tools within the OCR-D ecosphere.

All packages are also published to PyPI.

Installation

NOTE Unless you want to contribute to OCR-D/core, we recommend installation as part of ocrd_all which installs a complete stack of OCR-D-related software.

The easiest way to install is via pip:

pip install ocrd

# or just the functionality you need, e.g.

pip install ocrd_modelfactory

All Python software released by OCR-D requires Python 3.8 or higher.

NOTE Some OCR-D-Tools (or even test cases) might reveal an unintended behavior if you have specific environment modifications, like:

using a custom build of ImageMagick, whose format delegates are different from what OCR-D supposes
custom Python logging configurations in your personal account

Command line tools

NOTE: All OCR-D CLI tools support a --help flag which shows usage and supported flags, options and arguments.

`ocrd` CLI

`ocrd-dummy` CLI

A minimal OCR-D processor that copies from -I/-input-file-grp to -O/-output-file-grp

Configuration

Almost all behaviour of the OCR-D/core software is configured via CLI options and flags, which can be listed with the --help flag that all CLI support.

Some parts of the software are configured via environment variables:

OCRD_METS_CACHING: If set to true, access to the METS file is cached, speeding in-memory search and modification.
OCRD_PROFILE: This variable configures the built-in CPU and memory profiling. If empty, no profiling is done. Otherwise expected to contain any of the following tokens:
- CPU: Enable CPU profiling of processor runs
- RSS: Enable RSS memory profiling
- PSS: Enable proportionate memory profiling
OCRD_PROFILE_FILE: If set, then the CPU profile is written to this file for later peruse with a analysis tools like snakeviz
PATH: Search path for processor executables (affects ocrd process and ocrd resmgr).
HOME: Directory to look for ocrd_logging.conf, fallback for unset XDG variables (see below).
XDG_CONFIG_HOME: Directory to look for ./ocrd/resources.yml (i.e. ocrd resmgr user database) – defaults to $HOME/.config.
XDG_DATA_HOME: Directory to look for ./ocrd-resources/* (i.e. ocrd resmgr data location) – defaults to $HOME/.local/share.
OCRD_DOWNLOAD_RETRIES: Number of times to retry failed attempts for downloads of workspace files.
OCRD_DOWNLOAD_TIMEOUT: Timeout in seconds for connecting or reading (comma-separated) when downloading.
OCRD_METS_CACHING: Whether to enable in-memory storage of OcrdMets data structures for speedup during processing or workspace operations.
OCRD_MAX_PROCESSOR_CACHE: Maximum number of processor instances (for each set of parameters) to be kept in memory (including loaded models) for processing workers or processor servers.
OCRD_NETWORK_SERVER_ADDR_PROCESSING: Default address of Processing Server to connect to (for ocrd network client processing).
OCRD_NETWORK_SERVER_ADDR_WORKFLOW: Default address of Workflow Server to connect to (for ocrd network client workflow).
OCRD_NETWORK_SERVER_ADDR_WORKSPACE: Default address of Workspace Server to connect to (for ocrd network client workspace).
OCRD_NETWORK_RABBITMQ_CLIENT_CONNECT_ATTEMPTS: Number of attempts for a worker to create its queue. Helpful if the rabbitmq-server needs time to be fully started.

Packages

ocrd_utils

Contains utilities and constants, e.g. for logging, path normalization, coordinate calculation etc.

See README for ocrd_utils for further information.

ocrd_models

Contains file format wrappers for PAGE-XML, METS, EXIF metadata etc.

See README for ocrd_models for further information.

ocrd_modelfactory

Code to instantiate models from existing data.

See README for ocrd_modelfactory for further information.

ocrd_validators

Schemas and routines for validating BagIt, ocrd-tool.json, workspaces, METS, page, CLI parameters etc.

See README for ocrd_validators for further information.

ocrd_network

Components related to OCR-D Web API

See README for ocrd_network for further information.

ocrd

Depends on all of the above, also contains decorators and classes for creating OCR-D processors and CLIs.

Also contains the command line tool ocrd.

See README for ocrd for further information.

bash library

Builds a bash script that can be sourced by other bash scripts to create OCRD-compliant CLI.

See README for bashlib for further information.

Testing

Download assets (make assets)

Test with local files: make test

Test with remote assets:
- make test OCRD_BASEURL='https://github.com/OCR-D/assets/raw/master/data/'

ocrd dependencies

docker filetype flask gdown jsonschema lxml numpy opencv-python-headless paramiko python-magic python-multipart pyyaml requests requests-unixsocket2 shapely uvicorn

FAQs

What is ocrd?

OCR-D framework. Visit Snyk Advisor to see a full health score report for ocrd, including popularity, security, maintenance & community analysis.

Is ocrd popular?

The python package ocrd receives a total of 3,524 weekly downloads. As such, ocrd popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is ocrd well maintained?

We found that ocrd demonstrated a healthy version release cadence and project activity. It has a community of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is ocrd safe to use?

The python package ocrd was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 14 November-2024, at 09:07 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP