Data

Tools

Indexes

Applications

Experiments

Open Source Science

super-repo

A template repo to test and document repo elements and features

https://github.com/rl-institut/super-repo

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
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.7%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

A template repo to test and document repo elements and features

Basic Info
Statistics
  • Stars: 16
  • Watchers: 7
  • Forks: 0
  • Open Issues: 4
  • Releases: 6
Created about 4 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.rst 

..
  SPDX-FileCopyrightText: 2022 Ludwig Hülk  © Reiner Lemoine Institut
  SPDX-FileCopyrightText: super-repo v0.5.0 
  SPDX-License-Identifier: MIT

.. figure:: https://user-images.githubusercontent.com/14353512/185425447-85dbcde9-f3a2-4f06-a2db-0dee43af2f5f.png
    :align: left
    :target: https://github.com/rl-institut/super-repo/
    :alt: Repo logo

==========
super-repo
==========

**A template repo to test and document elements and features for research software.**

.. list-table::
   :widths: auto

   * - License
     - |badge_license| |badge_reuse|
   * - Documentation
     - |badge_documentation| |badge_mkdocs|
   * - Tests
     - |badge_tox| |badge_codecov|
   * - Publication
     - |badge_pypi| |badge_python| |badge_pypi_downloads|
   * - Development
     - |badge_issue_open| |badge_issue_closes| |badge_pr_open| |badge_pr_closes|
   * - Community
     - |badge_contributions| |badge_contributors| |badge_matrix| |badge_repo_counts|

.. contents::
    :depth: 2
    :local:
    :backlinks: top

Introduction
============
| A template repo to test and document elements and features for research software.
| It implements the collection of repository elements collected in this `Etherpad `_.
| The goal is to simplify and standardize the creation of software in GitHub repositories.

Documentation
=============
| The documentation is created with Markdown using `MkDocs `_ and `mike `_.
| All files are stored in the ``docs`` folder of the repository.
| A **GitHub Actions** deploys the ``develop`` branch on a **GitHub Page**.
| The documentation page is: `rl-institut.github.io/super-repo/ `_

Collaboration
=============
| Everyone is invited to develop this repository with good intentions.
| Please follow the workflow described in the `CONTRIBUTING.md `_.

Contributors:

.. figure:: https://contrib.rocks/image?repo=rl-institut/super-repo
    :align: left
    :target: https://github.com/rl-institut/super-repo/graphs/contributors
    :alt: [contrib.rocks](https://contrib.rocks)

License and Citation
====================
| The code of this repository is licensed under the **MIT License** (MIT).
| See `LICENSE.txt `_ for rights and obligations.
| See the *Cite this repository* function or `CITATION.cff `_ for citation of this repository.
| Copyright: `super-repo `_ © `Reiner Lemoine Institut `_ | `MIT `_


.. |badge_license| image:: https://img.shields.io/github/license/rl-institut/super-repo
    :target: https://github.com/rl-institut/super-repo/blob/production/LICENSE.txt
    :alt: License

.. |badge_reuse| image:: https://api.reuse.software/badge/github.com/rl-institut/super-repo
    :target: https://api.reuse.software/info/github.com/rl-institut/super-repo
    :alt: REUSE

.. |badge_documentation| image:: https://img.shields.io/github/actions/workflow/status/rl-institut/super-repo/documentation.yml?branch=develop&label=documentation
    :target: https://rl-institut.github.io/super-repo/
    :alt: Documentation

.. |badge_mkdocs| image:: https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=flat&logo=MaterialForMkDocs&logoColor=white&color=grey
    :target: https://squidfunk.github.io/mkdocs-material/
    :alt: MkDocs

.. |badge_tox| image:: https://img.shields.io/github/actions/workflow/status/rl-institut/super-repo/tox.yml?label=tox
    :target: https://github.com/rl-institut/super-repo/actions/workflows/tox.yml
    :alt: Tox Tests

.. |badge_codecov| image:: https://codecov.io/gh/rl-institut/super-repo/graph/badge.svg?token=YYCJI3D5G5
    :target: https://codecov.io/gh/rl-institut/super-repo
    :alt: Codecov

.. |badge_pypi| image:: https://img.shields.io/pypi/v/super-repo
    :target: https://pypi.org/project/super-repo/
    :alt: PyPI Version

.. |badge_python| image:: https://img.shields.io/pypi/pyversions/super-repo
    :target: https://github.com/rl-institut/super-repo/blob/develop/pyproject.toml
    :alt: PyPI Python Version

.. |badge_pypi_downloads| image:: https://img.shields.io/pypi/dm/super-repo
    :target: https://pypi.org/project/super-repo/
    :alt: PyPI Downloads

.. |badge_issue_open| image:: https://img.shields.io/github/issues-raw/rl-institut/super-repo
    :target: https://github.com/rl-institut/super-repo/issues
    :alt: Open Issues

.. |badge_issue_closes| image:: https://img.shields.io/github/issues-closed-raw/rl-institut/super-repo
    :target: https://github.com/rl-institut/super-repo/issues?q=is%3Aissue+is%3Aclosed
    :alt: Closed Issues

.. |badge_pr_open| image:: https://img.shields.io/github/issues-pr-raw/rl-institut/super-repo
    :target: https://github.com/rl-institut/super-repo/pulls
    :alt: Open PR

.. |badge_pr_closes| image:: https://img.shields.io/github/issues-pr-closed-raw/rl-institut/super-repo
    :target: https://github.com/rl-institut/super-repo/pulls?q=is%3Apr+is%3Aclosed
    :alt: Closed PR

.. |badge_contributions| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
    :target: https://github.com/rl-institut/super-repo/blob/production/CONTRIBUTING.md
    :alt: Contributions

.. |badge_contributors| image:: https://img.shields.io/github/contributors/rl-institut/super-repo
    :target: https://github.com/rl-institut/super-repo/graphs/contributors
    :alt: Contributors

.. |badge_matrix| image:: https://img.shields.io/matrix/super-repo:matrix.org
    :target: https://app.element.io/#/room/#super-repo:matrix.org
    :alt: Matrix

.. |badge_repo_counts| image:: https://hits.sh/github.com/rl-institut/super-repo.svg
    :target: https://hits.sh/github.com/rl-institut/super-repo/
    :alt: Hits

Owner

  • Name: Reiner Lemoine Institut
  • Login: rl-institut
  • Kind: organization
  • Location: Berlin/Germany

Citation (CITATION.cff) 

# SPDX-FileCopyrightText: 2022 Ludwig Hülk <https://github.com/Ludee> © Reiner Lemoine Institut
# SPDX-FileCopyrightText: super-repo v0.5.0 <https://github.com/rl-institut/super-repo>
# SPDX-License-Identifier: CC0-1.0

cff-version: 1.2.0
message: "If you use this software, please cite it using these metadata."
authors:
  - family-names: "Hülk"
    given-names: "Ludwig"
    alias: "Ludee"
    affiliation: "Reiner Lemoine Institut"
    orcid: "https://orcid.org/0000-0003-4655-2321"
  - family-names: "Huber"
    given-names: "Jonas"
    alias: "jh-rli"
    affiliation: "Reiner Lemoine Institut"
    orcid: "https://orcid.org/0000-0002-6234-0751"
title: "Super Repo"
type: software
license: MIT
version: 0.5.0
doi: null
date-released: 2024-12-09
url: "https://github.com/rl-institut/super-repo/"

GitHub Events

Total
  • Create event: 20
  • Release event: 3
  • Issues event: 39
  • Watch event: 3
  • Delete event: 15
  • Issue comment event: 11
  • Push event: 127
  • Pull request event: 36
Last Year
  • Create event: 20
  • Release event: 3
  • Issues event: 39
  • Watch event: 3
  • Delete event: 15
  • Issue comment event: 11
  • Push event: 127
  • Pull request event: 36

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 204
  • Total Committers: 2
  • Avg Commits per committer: 102.0
  • Development Distribution Score (DDS): 0.078
Past Year
  • Commits: 119
  • Committers: 2
  • Avg Commits per committer: 59.5
  • Development Distribution Score (DDS): 0.134
Top Committers
Name Email Commits
Ludee L****k@r****e 188
jh-RLI j****r@r****e 16
Committer Domains (Top 20 + Academic)
rl-institut.de: 2

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 36
  • Total pull requests: 64
  • Average time to close issues: 11 months
  • Average time to close pull requests: 10 days
  • Total issue authors: 3
  • Total pull request authors: 2
  • Average comments per issue: 1.47
  • Average comments per pull request: 0.11
  • Merged pull requests: 61
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 15
  • Pull requests: 24
  • Average time to close issues: 5 days
  • Average time to close pull requests: about 6 hours
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.07
  • Average comments per pull request: 0.08
  • Merged pull requests: 24
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • Ludee (30)
  • jh-RLI (4)
  • henhuy (1)
Pull Request Authors
  • Ludee (65)
  • jh-RLI (5)
Top Labels
Issue Labels
status: active :construction: (19) type: feature :hammer_and_wrench: (16) type: enhancement :gear: (15) priority: high :zap: (14) part: docu :book: (14) status: completed :heavy_check_mark: (13) part: backend :bricks: (13) part: github :octocat: (12) priority: critical :fire: (11) priority: low :sloth: (7) other: help wanted :raising_hand: (7) resolution: released :tada: (6) time: S (day) ⏳ (5) status: discussion :speech_balloon: (5) type: release :rocket: (5) time: M (week) 🕗 (1) status: blocked :stop_sign: (1) part: community :earth_africa: (1) type: bug :bug: (1) other: good first issue :seedling: (1) other: example :triangular_ruler: (1)
Pull Request Labels
status: completed :heavy_check_mark: (56) part: docu :book: (33) type: enhancement :gear: (29) resolution: released :tada: (25) part: github :octocat: (21) type: release :rocket: (21) type: feature :hammer_and_wrench: (16) priority: critical :fire: (16) priority: high :zap: (14) part: backend :bricks: (11) status: active :construction: (7) time: S (day) ⏳ (4) type: bug :bug: (4) priority: low :sloth: (4) resolution: invalid :x: (3) status: discussion :speech_balloon: (2) part: frontend :desktop_computer: (1) time: M (week) 🕗 (1) part: community :earth_africa: (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 6 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
  • Total maintainers: 1
pypi.org: super-repo

A template repo for research software.

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 6 Last month
Rankings
Dependent packages count: 9.9%
Stargazers count: 17.3%
Average: 28.7%
Forks count: 31.9%
Dependent repos count: 55.8%
Maintainers (1)
Ludee
Last synced: 8 months ago

Dependencies

.github/workflows/gh-pages.yml actions
  • actions/cache v2 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
requirements.txt pypi
  • mkdocs *
  • mkdocs-material *
  • mkdocstrings *
  • mkdocstrings-python-legacy *