credcheck

Name	credcheck JSON
Version	0.0.3 JSON
	download
home_page	https://gitlab.com/crossref/labs/credCheck
Summary	A tool to determine Crossref credential permissions.
upload_time	2024-03-13 09:35:45
maintainer
docs_url	None
author	Martin Paul Eve
requires_python	>=3.8
license
keywords	digital-preservation crossref
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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](https://img.shields.io/gitlab/license/crossref/labs/credCheck) ![activity](https://img.shields.io/gitlab/last-commit/crossref/labs/credCheck)

![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black) ![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)

![credCheck](logo/logo.png)

## 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

            

Raw data

            {
    "_id": null,
    "home_page": "https://gitlab.com/crossref/labs/credCheck",
    "name": "credcheck",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Martin Paul Eve <meve@crossref.org>",
    "keywords": "digital-preservation,crossref",
    "author": "Martin Paul Eve",
    "author_email": "meve@crossref.org",
    "download_url": "https://files.pythonhosted.org/packages/9b/2e/d87583600bff0c9e08b7f2bda3c21fe2dcac90f78da5d0514306051edc68/credcheck-0.0.3.tar.gz",
    "platform": null,
    "description": "# credCheck: lookup Crossref credential permissions\ncredCheck 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.\n\n![license](https://img.shields.io/gitlab/license/crossref/labs/credCheck) ![activity](https://img.shields.io/gitlab/last-commit/crossref/labs/credCheck)\n\n![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black) ![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)\n\n![credCheck](logo/logo.png)\n\n## Install\n\n    pip install credcheck\n\n## CLI Usage\n\n     Usage: cli.py [OPTIONS] USERNAME PASSWORD DOI\n                                                                                                                                                                                                                                            \n     Checks the credentials for a given username, password, and doi.\n\n    \u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n    \u2502 *    username      TEXT  The username [default: None] [required]                                                                                                \u2502\n    \u2502 *    password      TEXT  The password [default: None] [required]                                                                                                \u2502\n    \u2502 *    doi           TEXT  The doi with prefix to check [default: None] [required]                                                                                \u2502\n    \u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n    \u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n    \u2502 --install-completion        [bash|zsh|fish|powershell|pwsh]  Install completion for the specified shell. [default: None]                                        \u2502\n    \u2502 --show-completion           [bash|zsh|fish|powershell|pwsh]  Show completion for the specified shell, to copy it or customize the installation. [default: None] \u2502\n    \u2502 --help                                                       Show this message and exit.                                                                        \u2502\n    \u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\n## Programmatic Usage\n\n    import cred\n    credential = cred.Credential(username=username, password=password, doi=doi)\n\n    if not credential.is_authenticated():\n        ...\n\n    if credential.is_authorised():\n        ...\n\n&copy; Crossref 2024\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A tool to determine Crossref credential permissions.",
    "version": "0.0.3",
    "project_urls": {
        "Homepage": "https://gitlab.com/crossref/labs/credCheck",
        "documentation": "https://labs.crossref.org",
        "homepage": "https://labs.crossref.org",
        "repository": "https://gitlab.com/crossref/labs/credCheck"
    },
    "split_keywords": [
        "digital-preservation",
        "crossref"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "78331aee0dfcc744dcb66f0386deb0e4d2fe533352dec97263ecf51935449e0a",
                "md5": "ab3919f9b43db761c9afa106d7b59b67",
                "sha256": "8fcd6235cbe6c96759e3a5ce7169cae6d79d1b664661af49f8e845c45072868f"
            },
            "downloads": -1,
            "filename": "credcheck-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ab3919f9b43db761c9afa106d7b59b67",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 3451,
            "upload_time": "2024-03-13T09:35:42",
            "upload_time_iso_8601": "2024-03-13T09:35:42.912141Z",
            "url": "https://files.pythonhosted.org/packages/78/33/1aee0dfcc744dcb66f0386deb0e4d2fe533352dec97263ecf51935449e0a/credcheck-0.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9b2ed87583600bff0c9e08b7f2bda3c21fe2dcac90f78da5d0514306051edc68",
                "md5": "eb90ce7219bda0a098cff1f845c27a94",
                "sha256": "0df5d7989680bdabe0c18270d04aa108a738f1965f5a0ab3b750758ea445782c"
            },
            "downloads": -1,
            "filename": "credcheck-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "eb90ce7219bda0a098cff1f845c27a94",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 3462,
            "upload_time": "2024-03-13T09:35:45",
            "upload_time_iso_8601": "2024-03-13T09:35:45.341682Z",
            "url": "https://files.pythonhosted.org/packages/9b/2e/d87583600bff0c9e08b7f2bda3c21fe2dcac90f78da5d0514306051edc68/credcheck-0.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-13 09:35:45",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "crossref",
    "gitlab_project": "labs",
    "lcname": "credcheck"
}