Package Health Score

66 / 100

security
Security review needed
popularity
Small
maintenance
Healthy
community
Sustainable

Popularity

Small

GitHub Stars: 19
Forks: 7
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package regula.documentreader.webclient, we found that it has been starred 19 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Dec 16, 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

Unknown

Unable to detect license

We couldn’t find an appropriate license for this project. It is highly advised to make sure the project license is compatible with your business needs before including it as a dependency, to keep yourself protected from infringement suits or loss of your own code.

Security Policy

We found a way for you to contribute to the project! Looks like regula.documentreader.webclient 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: 0
Open PR: 2
Last Release: 5 days ago
Last Commit: 23 days ago

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

We found that regula.documentreader.webclient 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 regula.documentreader.webclient 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 regula.documentreader.webclient is missing a Code of Conduct.

How about a good first contribution to this project? It seems that regula.documentreader.webclient is missing a LICENSE file.

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: 4 years
Latest Release: 4 days ago
Dependencies: 0 Direct
Versions: 178
Maintainers: 0
Wheels: OS Independent

Readme

Regula Document Reader web API Python 3.8+ client

Documents recognition as easy as reading two bytes.

If you have any problems with or questions about this client, please contact us through a GitHub issue. You are invited to contribute new features, fixes, or updates, large or small; We are always thrilled to receive pull requests, and do our best to process them as fast as we can. See dev guide

Install package

regula.documentreader.webclient is on the Python Package Index (PyPI):

pip install regula.documentreader.webclient

Or using pipenv

pipenv install regula.documentreader.webclient

Example

Performing request:

from regula.documentreader.webclient import *

with open("australia_passport.jpg", "rb") as f:
    input_image = f.read()

with DocumentReaderApi(host='http://localhost:8080') as api:
    params = ProcessParams(
        scenario=Scenario.FULL_PROCESS,
        result_type_output=[Result.DOCUMENT_IMAGE, Result.STATUS, Result.TEXT, Result.IMAGES]
    )
    request = RecognitionRequest(process_params=params, images=[input_image])
    response = api.process(request)

Parsing results:

# status examples
response_status = response.status
doc_overall_status = "valid" if response_status.overall_status == CheckResult.OK else "not valid"

# text fields example
doc_number_field = response.text.get_field(TextFieldType.DOCUMENT_NUMBER)
doc_number_mrz = doc_number_field.get_value()
doc_number_visual = doc_number_field.get_value(Source.VISUAL)
doc_number_visual_validity = doc_number_field.source_validity(Source.VISUAL)
doc_number_mrz_validity = doc_number_field.source_validity(Source.MRZ)
doc_number_mrz_visual_matching = doc_number_field.cross_source_comparison(Source.MRZ, Source.VISUAL)

# images fields example
normalized_input_image = response.images.document_image()
portrait_field = response.images.get_field(GraphicFieldType.PORTRAIT)
portrait_from_visual = portrait_field.get_value(Source.VISUAL)
portrait_from_rfid = portrait_field.get_value(Source.RFID, original=True)

You can find more detailed guide and run this sample in example folder.

FAQs

What is regula.documentreader.webclient?

Regula's Document Reader python client. Visit Snyk Advisor to see a full health score report for regula.documentreader.webclient, including popularity, security, maintenance & community analysis.

Is regula.documentreader.webclient popular?

The python package regula.documentreader.webclient receives a total of 2,597 weekly downloads. As such, regula.documentreader.webclient popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is regula.documentreader.webclient well maintained?

We found that regula.documentreader.webclient 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 regula.documentreader.webclient safe to use?

While scanning the latest version of regula.documentreader.webclient, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 18 December-2024, at 14:26 (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

regula.documentreader.webclient

Regula's Document Reader python client For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Unable to detect license

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

Regula Document Reader web API Python 3.8+ client

Install package

Example

FAQs

What is regula.documentreader.webclient?

Is regula.documentreader.webclient popular?

Is regula.documentreader.webclient well maintained?

Is regula.documentreader.webclient safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

Regula Document Reader web API Python 3.8+ client

Install package

Example

FAQs

What is regula.documentreader.webclient?

Is regula.documentreader.webclient popular?

Is regula.documentreader.webclient well maintained?

Is regula.documentreader.webclient safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues