{"id":17437195,"url":"https://github.com/simsys/lxpapi","last_synced_at":"2026-02-12T18:02:45.715Z","repository":{"id":62577170,"uuid":"166979614","full_name":"Simsys/LxpApi","owner":"Simsys","description":"Library and Command Line Interface for the LxpApi (www.letterxpress.de)","archived":false,"fork":false,"pushed_at":"2020-01-18T15:41:48.000Z","size":65,"stargazers_count":2,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-03T06:39:17.550Z","etag":null,"topics":["command-line-tool","online-printing","python","python-3","rest-api"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Simsys.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-22T11:05:30.000Z","updated_at":"2022-02-16T23:18:24.000Z","dependencies_parsed_at":"2022-11-03T19:12:02.069Z","dependency_job_id":null,"html_url":"https://github.com/Simsys/LxpApi","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/Simsys/LxpApi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simsys%2FLxpApi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simsys%2FLxpApi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simsys%2FLxpApi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simsys%2FLxpApi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Simsys","download_url":"https://codeload.github.com/Simsys/LxpApi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simsys%2FLxpApi/sbom","scorecard":{"id":130383,"data":{"date":"2025-08-11","repo":{"name":"github.com/Simsys/LxpApi","commit":"1daf42fb39ec6f2bea61fd7e185af763fff6e55e"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.7,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/14 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU Lesser General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact build33 not signed: https://api.github.com/repos/Simsys/LxpApi/releases/15265986","Warn: release artifact build31 not signed: https://api.github.com/repos/Simsys/LxpApi/releases/15265432","Warn: release artifact build29 not signed: https://api.github.com/repos/Simsys/LxpApi/releases/15264090","Warn: release artifact build27 not signed: https://api.github.com/repos/Simsys/LxpApi/releases/15263618","Warn: release artifact build33 does not have provenance: https://api.github.com/repos/Simsys/LxpApi/releases/15265986","Warn: release artifact build31 does not have provenance: https://api.github.com/repos/Simsys/LxpApi/releases/15265432","Warn: release artifact build29 does not have provenance: https://api.github.com/repos/Simsys/LxpApi/releases/15264090","Warn: release artifact build27 does not have provenance: https://api.github.com/repos/Simsys/LxpApi/releases/15263618"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}}]},"last_synced_at":"2025-08-16T05:09:03.213Z","repository_id":62577170,"created_at":"2025-08-16T05:09:03.213Z","updated_at":"2025-08-16T05:09:03.213Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273403948,"owners_count":25099299,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line-tool","online-printing","python","python-3","rest-api"],"created_at":"2024-10-17T11:06:41.104Z","updated_at":"2026-02-12T18:02:45.685Z","avatar_url":"https://github.com/Simsys.png","language":"Python","readme":"# LxpApi\nLibrary and Command-Line Interface for the LxpApi (www.letterxpress.de)\n\nThe package consists of two building blocks:\n- Python library LxpApi to integrate the interface into Python applications.\n- Command line tool lxpservice, which is [explained here](https://github.com/Simsys/LxpApi/blob/master/lxpservice.md). \n\nInstalling LxpApi\n-----------------\n\nAs usual, LxpApi is installed with pip (or pip3). This will install both the library and the command line tool.\n```\n$pip install lxpservice\n```\nUsing LxpApi\n------------\n\nFirst import the LxpAPi library and pprint for nice view on complex python types.\n```python\n\u003e\u003e\u003e from LxpApi import LxpApi\n\u003e\u003e\u003e from pprint import pprint\n```\nCreate an instance of LxpApi with the credentials\n```python\n\u003e\u003e\u003e url = \"https://sandbox.letterxpress.de/v1/\"\n\u003e\u003e\u003e user = \u003cUser-Name\u003e\n\u003e\u003e\u003e api_key = \u003cApi-Key\u003e\n\u003e\u003e\u003e lxp_api = LxpApi(url, user, api_key)\n```\nNow we can work with the API and execute various commands. The library always returns an answer from which it can be seen if the function could be executed successfully.\n\nLet's first look at the current credit balance.\n```python\n\u003e\u003e\u003e response = lxp_api.get_balance()\n\u003e\u003e\u003e pprint(response)\n{'auth': {'id': '46', 'status': 'active', 'user': \u003cUser-Name\u003e},\n 'balance': {'currency': 'EUR', 'value': '91.59'},\n 'message': 'OK',\n 'status': 200}\n```\nNow we upload a PDF file to the server\n```python\n\u003e\u003e\u003e response=lxp_api.set_job('one-page.pdf')\n\u003e\u003e\u003e pprint(response)\n{'auth': {'id': '46', 'status': 'active', 'user': \u003cUser-Name\u003e},\n 'letter': {'job_id': '3422',\n            'price': 0.74,\n            'specification': {'color': 1,\n                              'mode': 'simplex',\n                              'page': 1,\n                              'ship': 'national'},\n            'status': 'queue'},\n 'message': 'OK',\n 'status': 200}\n```\nIn response, we receive some information such as the price or other attributes of the order. These attributes can be influenced during upload. How todo this and other information can be found in the [library documentation](https://github.com/Simsys/LxpApi/blob/master/LxpApi/lxpapi.py). Alternatively they can be retrieved with help(LxpApi). All available methods and possible parameters are described here.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimsys%2Flxpapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimsys%2Flxpapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimsys%2Flxpapi/lists"}