Science Score: 54.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
  • Committers with academic emails
    1 of 1 committers (100.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.0%) to scientific vocabulary
Last synced: 9 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: thompson318
  • License: gpl-3.0
  • Language: HTML
  • Default Branch: main
  • Size: 1.6 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

radio_server

pre-commit Tests status Linting status Documentation status License

A simple web server to play selected radio stations

This project is developed in collaboration with the Centre for Advanced Research Computing, University College London.

About

Project Team

Stephen Thompson (s.thompson@ucl.ac.uk)

Research Software Engineering Contact

Centre for Advanced Research Computing, University College London (arc.collaborations@ucl.ac.uk)

Built With

Getting Started

Prerequisites

radio-server requires Python 3.10–3.12.

Installation

We recommend installing in a project specific virtual environment created using a environment management tool such as Conda. To install the latest development version of radio-server using pip in the currently active environment run

sh pip install git+https://github.com/thompson318/radio-server.git

Alternatively create a local clone of the repository with

sh git clone https://github.com/thompson318/radio-server.git

and then install in editable mode by running

sh pip install -e .

Running Locally

How to run the application on your local system.

Running Tests

Tests can be run across all compatible Python versions in isolated environments using tox by running

sh tox

To run tests manually in a Python environment with pytest installed run

sh pytest tests

again from the root of the repository.

Building Documentation

The MkDocs HTML documentation can be built locally by running

sh tox -e docs

from the root of the repository. The built documentation will be written to site.

Alternatively to build and preview the documentation locally, in a Python environment with the optional docs dependencies installed, run

sh mkdocs serve

Roadmap

  • [x] Initial Research
  • [ ] Minimum viable product <-- You are Here
  • [ ] Alpha Release
  • [ ] Feature-Complete Release

Acknowledgements

This work was funded by none.

Owner

  • Name: Stephen Thompson
  • Login: thompson318
  • Kind: user
  • Location: London, United Kingdom
  • Company: Advanced Research Computing, UCL

Research Software Engineer

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
type: software
authors:
  - family-names: "Thompson"
    given-names: "Stephen"
    email: "s.thompson@ucl.ac.uk"
repository-code: "https://github.com/thompson318/radio-server"
title: "radio_server: A simple web server to play selected radio stations"
license: "GPL-3.0"

GitHub Events

Total
  • Push event: 7
Last Year
  • Push event: 7

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 21
  • Total Committers: 1
  • Avg Commits per committer: 21.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 21
  • Committers: 1
  • Avg Commits per committer: 21.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Stephen Thompson s****n@u****k 21
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total 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
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
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels