Metadata-Version: 2.4
Name: pyCEURspt
Version: 0.1.1
Dynamic: Summary
Project-URL: Home, https://github.com/ceurws/ceur-spt
Project-URL: Documentation, https://github.com/ceurws/ceur-spt
Project-URL: Source, https://github.com/ceurws/ceur-spt
Author-email: Tim Holzheim <tim.holzheim@rwth-aachen.de>, Wolfgang Fahl <wf@bitplan.com>
Maintainer-email: Wolfgang Fahl <wf@bitplan.com>, Tim Holzheim <tim.holzheim@rwth-aachen.de>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Requires-Dist: beautifulsoup4
Requires-Dist: bibtexparser
Requires-Dist: fastapi[all]
Requires-Dist: linkml-runtime
Requires-Dist: oauthlib
Requires-Dist: orjson>=3.8.9
Requires-Dist: pyyaml
Requires-Dist: tqdm
Requires-Dist: uvicorn
Provides-Extra: test
Requires-Dist: green; extra == 'test'
Description-Content-Type: text/markdown

# ceur-spt

RESTFul Single Point of Truth Server for CEUR-WS

| | |
| :--- | :--- |
| **PyPi** | [![PyPI Status](https://img.shields.io/pypi/v/pyCEURspt.svg)](https://pypi.python.org/pypi/pyCEURspt/) [![License](https://img.shields.io/github/license/ceurws/ceur-spt.svg)](https://www.apache.org/licenses/LICENSE-2.0) [![pypi](https://img.shields.io/pypi/pyversions/pyCEURspt)](https://pypi.org/project/pyCEURspt/) [![format](https://img.shields.io/pypi/format/pyCEURspt)](https://pypi.org/project/pyCEURspt/) [![downloads](https://img.shields.io/pypi/dd/pyCEURspt)](https://pypi.org/project/pyCEURspt/) |
| **GitHub** | [![Github Actions Build](https://github.com/ceurws/ceur-spt/actions/workflows/build.yml/badge.svg)](https://github.com/ceurws/ceur-spt/actions/workflows/build.yml) [![Release](https://img.shields.io/github/v/release/ceurws/ceur-spt)](https://github.com/ceurws/ceur-spt/releases) [![Contributors](https://img.shields.io/github/contributors/ceurws/ceur-spt)](https://github.com/ceurws/ceur-spt/graphs/contributors) [![Last Commit](https://img.shields.io/github/last-commit/ceurws/ceur-spt)](https://github.com/ceurws/ceur-spt/commits/) [![GitHub issues](https://img.shields.io/github/issues/ceurws/ceur-spt.svg)](https://github.com/ceurws/ceur-spt/issues) [![GitHub closed issues](https://img.shields.io/github/issues-closed/ceurws/ceur-spt.svg)](https://github.com/ceurws/ceur-spt/issues/?q=is%3Aissue+is%3Aclosed) |
| **Code** | [![style-black](https://img.shields.io/badge/%20style-black-000000.svg)](https://github.com/psf/black) [![imports-isort](https://img.shields.io/badge/%20imports-isort-%231674b1)](https://pycqa.github.io/isort/) [![Join the discussion at https://github.com/ceurws/ceur-spt/discussions](https://img.shields.io/github/discussions/ceurws/ceur-spt)](https://github.com/ceurws/ceur-spt/discussions) |
| **Docs** | [![API Docs](https://img.shields.io/badge/API-Documentation-blue)](https://ceurws.github.io/ceur-spt/) [![formatter-docformatter](https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg)](https://github.com/PyCQA/docformatter) [![style-google](https://img.shields.io/badge/%20style-google-3666d6.svg)](https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings) |
| **Cite** | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.20037981.svg)](https://doi.org/10.5281/zenodo.20037981) |

## Cite as

If you use ceur-spt in your research, please cite it via its Zenodo concept DOI
(which always resolves to the latest version):

> Fahl, W., Holzheim, T., & byzakyz.
> *ceur-spt — RESTful Single Point of Truth server for CEUR-WS.*
> Zenodo. https://doi.org/10.5281/zenodo.20037981

Machine-readable metadata is available in [`CITATION.cff`](./CITATION.cff);
GitHub's "Cite this repository" button and Zenodo pick it up automatically.
For a specific release, use the version DOI shown on the corresponding
[Zenodo record](https://doi.org/10.5281/zenodo.20037981).

## Introduction

### CEUR-WS
CEUR Workshop Proceedings (CEUR-WS.org) —
Free Open-Access Proceedings for Computer Science Workshops
https://ceur-ws.org/

**Mirror:** https://ceur-ws.wikidata.dbis.rwth-aachen.de/

### Semantification of CEUR-WS
- http://ceur-ws-browser.bitplan.com
- http://ceur-ws.bitplan.com

### Single Point of Truth
- http://ceurspt.wikidata.dbis.rwth-aachen.de/index.html
- http://ceurspt.wikidata.dbis.rwth-aachen.de/docs

## Installation
```
pipx install pyCEURspt
```
## Usage
### Command Line
```
usage: ceur-spt [-h] [-a] [-b BASEPATH] [-bu BASEURL] [-d] [-rc] [-v] [--host HOST] [--port PORT] [-s] [-V]

Copyright 2023-2026 contributors. All rights reserved.

  Licensed under the Apache License 2.0
  https://www.apache.org/licenses/LICENSE-2.0

  Distributed on an "AS IS" basis without warranties
  or conditions of any kind, either express or implied.

options:
  -h, --help            show this help message and exit
  -a, --about           show about info [default: False]
  -b BASEPATH, --basepath BASEPATH
                        the base path to the ceur-ws volumes [default:
                        /Users/wf/.local/pipx/venvs/pyceurspt/lib/python3.12/site-packages/ceur-ws]
  -bu BASEURL, --baseurl BASEURL
                        the base url to use for the RESTFul metadata service [default: http://cvb.bitplan.com]
  -d, --debug           show debug info [default: False]
  -rc, --recreate       reload caches e.g. volume table
  -v, --verbose         show verbose infos e.g. on startup [default: False]
  --host HOST           the host to serve / listen from [default: localhost]
  --port PORT           the port to serve from [default: 9990]
  -s, --serve           start webserver [default: False]
  -V, --version         show program's version number and exit
```
