Skip to main content

A tool to determine Crossref credential permissions.

Project description

credCheck: lookup Crossref credential permissions

credCheck allows you to test whether your Crossref credentials have the necessary permissions to deposit a DOI. It is a simple command-line tool that takes a DOI and Crossref username and password and returns a boolean value indicating whether the user has the necessary permissions to deposit the DOI.

license activity

Linux Python

credCheck

Install

pip install credcheck

CLI Usage

 Usage: cli.py [OPTIONS] USERNAME PASSWORD DOI
                                                                                                                                                                                                                                        
 Checks the credentials for a given username, password, and doi.

╭─ Arguments ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *    username      TEXT  The username [default: None] [required]                                                                                                │
│ *    password      TEXT  The password [default: None] [required]                                                                                                │
│ *    doi           TEXT  The doi with prefix to check [default: None] [required]                                                                                │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion        [bash|zsh|fish|powershell|pwsh]  Install completion for the specified shell. [default: None]                                        │
│ --show-completion           [bash|zsh|fish|powershell|pwsh]  Show completion for the specified shell, to copy it or customize the installation. [default: None] │
│ --help                                                       Show this message and exit.                                                                        │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Programmatic Usage

import cred
credential = cred.Credential(username=username, password=password, doi=doi)

if not credential.is_authenticated():
    ...

if credential.is_authorised():
    ...

© Crossref 2024

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

credcheck-0.0.3.tar.gz (3.5 kB view hashes)

Uploaded Source

Built Distribution

credcheck-0.0.3-py3-none-any.whl (3.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page