Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.1%) to scientific vocabulary
Last synced: 8 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: interTwin-eu
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 1.48 MB
Statistics
  • Stars: 3
  • Watchers: 3
  • Forks: 1
  • Open Issues: 7
  • Releases: 11
Created over 2 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

Teapot

This application provides a WebDAV that supports multi-tenancy. It is based on StoRM-WebDAV. We have added a manager level that accepts requests, authenticates the user, identifies the local username of the user, starts a StoRM-WebDAV server for that local user with a randomly assigned port to listen on, and forwards the user's request to that port. The StoRM-WebDAV server will then handle the request in the usual way. If the StoRM-WebDAV server is inactive for 10 minutes, it will be shut down by the manager. If another request comes in for a different user, the manager will start another StoRM-WebDAV server for that user in the same way.

Getting Started

Requirements

Teapot needs Python3 to run, the specific distribution depends on the operating system. The required Python packages for installing Teapot are listed in the requirements.txt file. Python packages that aren't available in the rpm format are already included in Teapot's rpm file. To automatically generate self-signed certificate openssl>3 is needed. Storm-webdav needs java-17.

Installation & Configuration

Teapot can be installed via an RPM package. On the release page, we provide RPMs for Fedora 39, AlmaLinux 9.4, and Rocky Linux 9.3. If you need an RPM file for another Linux distribution, feel free to contact us and we’ll gladly provide you with one for your specific Linux distribution.

To install Teapot, first a user teapot must be created. To do that run sudo adduser teapot.

Please refer to CONFIGURATION.md for information on how to configure Teapot and Storm-Webdav.

Starting

Teapot starts automatically upon installation using a systemd unit file. Once configured, you can restart the service with sudo systemctl restart teapot.service. To ensure Teapot launches automatically after each reboot, enable it with sudo systemctl enable teapot.service.

Automated testing

Functional tests can be found in /robot. To execute them, run robot teapot-tests.robot.

Version

The current version of Teapot is 0.17.0, and it uses Storm-Webdav version 1.8.1.

Authors

Paul Millar, Dijana Vrbanec, Tim Wetzel

Acknowledgements

Teapot is a WebDAV solution that supports multi-tenancy. It is based on StoRM-WebDAV.

Owner

  • Name: interTwin Community
  • Login: interTwin-eu
  • Kind: organization
  • Email: info@intertwin.eu

Co-designing and prototyping an interdisciplinary Digital Twin Engine.

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Millar
    given-names: Paul
    orcid: https://orcid.org/0000-0002-3957-1279
  - family-names: Vrbanec
    given-names: Dijana
    orcid: https://orcid.org/0009-0000-8124-3650
  - family-names: Wetzel
    given-names: Tim
    orcid: https://orcid.org/0000-0002-9131-0906
title: "Teapot"
version: 0.8.0
license: Apache-2.0
repository-code: https://github.com/interTwin-eu/teapot

GitHub Events

Total
  • Create event: 23
  • Commit comment event: 162
  • Release event: 9
  • Issues event: 3
  • Watch event: 2
  • Delete event: 18
  • Issue comment event: 13
  • Push event: 170
  • Pull request event: 18
Last Year
  • Create event: 23
  • Commit comment event: 162
  • Release event: 9
  • Issues event: 3
  • Watch event: 2
  • Delete event: 18
  • Issue comment event: 13
  • Push event: 170
  • Pull request event: 18

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 2
  • Total pull requests: 9
  • Average time to close issues: about 1 year
  • Average time to close pull requests: 24 minutes
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.56
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 9
  • Average time to close issues: N/A
  • Average time to close pull requests: 24 minutes
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.56
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • vrbanecd (7)
  • wetzel-desy (1)
Pull Request Authors
  • vrbanecd (16)
  • paulmillar (5)
  • dependabot[bot] (4)
  • wetzel-desy (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (4)

Dependencies

.github/workflows/check-links.yml actions
  • actions/checkout v4 composite
  • gaurav-nelson/github-action-markdown-link-check v1 composite
.github/workflows/lint.yml actions
  • actions/checkout v4 composite
  • docker://ghcr.io/github/super-linter slim-v4 composite
requirements.txt pypi
  • fastapi *
  • flaat *
  • httpx *
  • java-11 *
  • liboidcagent *
  • logging *
  • openssl >3.0
  • pydantic *
  • python3 *
  • regex *
  • requests *
  • uvicorn *