spindle-server

Simple Flask-based webserver for Spindle

https://github.com/centrefordigitalhumanities/spindle-server

Science Score: 67.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
    Found 1 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Simple Flask-based webserver for Spindle

Basic Info
  • Host: GitHub
  • Owner: CentreForDigitalHumanities
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: develop
  • Size: 33.2 KB
Statistics
  • Stars: 0
  • Watchers: 5
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 2 years ago · Last pushed 10 months ago
Metadata Files
Readme License Citation

README.md

DOI License

Spindle Server

Spindle Server contains a Dockerfile that can be used to create a containerised Flask server with the Spindle parser, which produces type-logical analyses of Dutch sentences. This project is built as a dependency to ParsePort.

Contents

The main entry point is a Dockerfile that will create a container, install the necessary dependencies and move the atom_map.tsv and bert_config.json files over to the container. In addition, this repository expects to find a file with PyTorch model weights (model_weights.pt).

Prerequisites

A host machine with Docker installed and internet access.

Usage

  1. Put a copy of model_weights.pt in the root directory of this repository.

  2. Build an image with docker build -t spindle-server:latest .

  3. Run container and expose a port with docker run -d -p 32768:5000 --name spindle-server spindle-server

  4. After successful startup, the server will setup the parser. This may take a few minutes.

  5. Connect to the parser by sending a request to localhost:32768. The request should be a JSON object of the shape { 'input': '<my-sentence>'}, where <my-sentence> should be replaced with a Dutch sentence.

  6. If the parse fails, a response with status code 500 is returned. If the parser returns a so-called proof, it is included in the response.

  7. Upon successful parsing, the server will return a JSON object containing the following properties.

    • tex: the full analysis of the sentence in .tex format;
    • proof: the proof of the analysis (in JSON format);
    • lexical_phrases: analyses of the individual phrases (in JSON format).

Licence

Spindle Server is shared under a BSD 3-Clause licence. See LICENSE for more information.

Citation

If you wish to cite this repository, please use the metadata provided in our CITATION.cff file.

Contact

For questions, small feature suggestions, and bug reports, feel free to create an issue. If you do not have a Github account, you can also contact the Centre for Digital Humanities.

Owner

  • Name: Centre for Digital Humanities
  • Login: CentreForDigitalHumanities
  • Kind: organization
  • Email: cdh@uu.nl
  • Location: Netherlands

Interdisciplinary centre for research and education in computational and data-driven methods in the humanities.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Spindle Server
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Konstantinos
    family-names: Kogkalidis
    email: kokos.kogkalidis@aalto.fi
    orcid: 'https://orcid.org/0009-0008-1535-9717'
  - given-names: Michael
    family-names: Moortgat
    email: m.j.moortgat@uu.nl
    affiliation: Utrecht University Institute for Language Sciences
    orcid: 'https://orcid.org/0000-0003-3568-9920'
  - given-names: Ben
    family-names: Bonfil
    email: b.bonfil@uu.nl
    affiliation: Utrecht University Centre for Digital Humanities
  - given-names: Alexander
    family-names: Vertegaal
    email: a.j.j.vertegaal@uu.nl
    affiliation: Utrecht University Centre for Digital Humanities
    orcid: 'https://orcid.org/0000-0002-5182-6801'
  - given-names: Tijmen C.
    family-names: Baarda
    email: t.c.baarda@uu.nl
    affiliation: Utrecht University Centre for Digital Humanities
    orcid: 'https://orcid.org/0000-0002-2577-4948'
identifiers:
  - type: doi
    value: 10.5281/zenodo.10571295
repository-code: 'https://github.com/UUDigitalHumanitieslab/spindle-server'
abstract: Simple Flask-based webserver for Spindle.
keywords:
  - spindle
  - type-logical parser
  - computational linguistics
license: BSD-3-Clause
commit: 5042e349ab43b28e7a37b4bd3c764a969a1507d1
version: 0.3.0
date-released: '2025-05-01'

GitHub Events

Total
  • Create event: 1
  • Release event: 1
  • Issues event: 1
  • Delete event: 1
  • Member event: 1
  • Issue comment event: 1
  • Push event: 8
  • Pull request review event: 1
  • Pull request event: 1
Last Year
  • Create event: 1
  • Release event: 1
  • Issues event: 1
  • Delete event: 1
  • Member event: 1
  • Issue comment event: 1
  • Push event: 8
  • Pull request review event: 1
  • Pull request event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 25
  • Total Committers: 4
  • Avg Commits per committer: 6.25
  • Development Distribution Score (DDS): 0.44
Past Year
  • Commits: 6
  • Committers: 2
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.5
Top Committers
Name Email Commits
Xander Vertegaal a****l@u****l 14
Ben b****l@u****l 6
Meesch m****t@u****l 3
Xander Vertegaal x****r@v****l 2
Committer Domains (Top 20 + Academic)
uu.nl: 3 vasio.nl: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 5
  • Average time to close issues: 11 months
  • Average time to close pull requests: 10 days
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.2
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • XanderVertegaal (1)
Pull Request Authors
  • bbonf (3)
  • XanderVertegaal (2)
Top Labels
Issue Labels
Pull Request Labels