CiteLang
CiteLang: Modeling the Research Software Ecosystem - Published in JOSS (2022)
Science Score: 98.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 JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org, zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Keywords from Contributors
Scientific Fields
Repository
markdown syntax and credit system for software!
Basic Info
- Host: GitHub
- Owner: vsoch
- License: mpl-2.0
- Language: Python
- Default Branch: main
- Homepage: https://vsoch.github.io/citelang/getting_started/user-guide.html
- Size: 7.14 MB
Statistics
- Stars: 9
- Watchers: 2
- Forks: 3
- Open Issues: 3
- Releases: 25
Topics
Metadata Files
README.md
CiteLang
Welcome to CiteLang! CiteLang provides methods and graph-based modeling to study software ecosystems. You can use CiteLang for your research, or a provided tool to generate software graph artifacts, including (but not limited to):
- Generate basic software credit trees (citelang graph, badge, or markdown credit)
- Give credit accounting for dependencies! (see software-credit.md)
- Actions (automation) for the above!
For the examples above, we aren't using DOIs! A manually crafted identifier that a human has to remember to generate, in addition to a publication or release, is too much work for people to reasonably do. As research software engineers we also want to move away from the traditional "be valued like an academic" model. We are getting software metadata and a reference to an identifier via a package manager. This means that when you publish your software, you should publish it to an appropriate package manager.
Getting Started
If you want to use CiteLang as an analysis library, jump into the more detailed ⭐️ Documentation ⭐️ or look specifically at the Python API. As an example analysis, the RSEPedia Software Ecosystem is a completed automated setup that parses and summarizes dependencies across the Research Software Encyclopedia weekly, and it's powered by CiteLang! You can do similar analyses or build your own tools using CiteLang. We will provide a small summary of the tools available here.
Badges
CiteLang Badges can show an entire credit tree for a project:
or can be generated to be interactive web interfaces as shown here.
See the badge documentation for more examples of customizing the look, or level of abstraction. You can automatically generate or update a badge for your repository using the provided GitHub Action.
Credit and Graph
If you want to visually show dependency graphs, using Credit will print this to the console, and optionally in json if you want just the data. With the Graph command you can render different kinds of pretty graphs (or data formats dot, cypher, gexf) using this same data.
Contributions
CiteLang has a Contrib command and underlying API that can dig into your git history and look at contributions based on lines. You can read a complete write-up and see examples in this blog post. It is currently being used by the SingularityCE project to say thank you to contributors!
If you want to generate data programatically, we provide A GitHub action.
Render and Generate
The functionality that originally derived the name - a "markdown syntax for citations" means that we can start from a markdown paper that has some number of CiteLang formatted references, and result in a rendered paper that includes a credit table. This is done with the Render command, or you can just output a table into its own markdown file with Generate. We provide an example here and also provide a GitHub action for you to generate this for your own repository.
Contributors
We use the all-contributors tool to generate a contributors graphic below.
 Vanessasaurus 💻 |
 Dave Trudgian 💻 |
 Traceton 💻 |
 HY. Kelvin Lee 💻 |
License
This code is licensed under the MPL 2.0 LICENSE.
Owner
- Name: Vanessasaurus
- Login: vsoch
- Kind: user
- Website: https://vsoch.github.io
- Twitter: vsoch
- Repositories: 631
- Profile: https://github.com/vsoch
I'm the Vanessasaurus!
JOSS Publication
CiteLang: Modeling the Research Software Ecosystem
Authors
Lawrence Livermore National Laboratory, Livermore, CA, USA
Editor
Fabian-Robert Stöter
Tags
credit citation visualization analysis modeling research-software-engineeringCitation (CITATION.cff)
cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Sochat
given-names: Vanessa
orcid: https://orcid.org/0000-0002-4387-3819
title: "CiteLang: Modeling the Research Software Ecosystem"
version: 0.0.33
doi: 10.21105/joss.04458
date-released: 2022-09-04
GitHub Events
Total
- Create event: 2
- Release event: 1
- Issues event: 2
- Watch event: 1
- Delete event: 1
- Issue comment event: 6
- Push event: 5
- Pull request review event: 1
- Pull request event: 3
- Fork event: 1
Last Year
- Create event: 2
- Release event: 1
- Issues event: 2
- Watch event: 1
- Delete event: 1
- Issue comment event: 6
- Push event: 5
- Pull request review event: 1
- Pull request event: 3
- Fork event: 1
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Vanessasaurus | 8****h | 53 |
| github-actions[bot] | 4****] | 3 |
| github-actions | g****s | 2 |
| Traceton Timmerman | 4****n | 1 |
| HY. Kelvin Lee | 3****2 | 1 |
| Dave Trudgian | d****e@t****t | 1 |
| dctrud | d****d@r****t | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 9
- Total pull requests: 47
- Average time to close issues: about 6 hours
- Average time to close pull requests: 2 days
- Total issue authors: 4
- Total pull request authors: 5
- Average comments per issue: 0.67
- Average comments per pull request: 0.28
- Merged pull requests: 41
- Bot issues: 0
- Bot pull requests: 11
Past Year
- Issues: 1
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: about 3 hours
- Issue authors: 1
- Pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 1.5
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 1
Top Authors
Issue Authors
- vsoch (4)
- dtrudg (3)
- faroit (1)
- hykelvinlee42 (1)
Pull Request Authors
- vsoch (32)
- github-actions[bot] (11)
- dtrudg (2)
- Traceton (1)
- hykelvinlee42 (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 249 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 27
- Total maintainers: 1
pypi.org: citelang
Credit parser and markdown language for scientific software.
- Homepage: https://github.com/vsoch/citelang
- Documentation: https://citelang.readthedocs.io/
- License: LICENSE
-
Latest release: 0.0.35
published about 1 year ago
Rankings
Maintainers (1)
Dependencies
- cli >= 3.2.0 imports
- tibble * imports
- covr * suggests
- ggplot2 * suggests
- knitr * suggests
- rmarkdown * suggests
- testthat * suggests
- tidyr * suggests
- github.com/DataDrake/cli-ng/v2 v2.0.2
- github.com/alecbcs/lookout v1.2.7
- github.com/asottile/dockerfile v3.1.0+incompatible
- github.com/blang/semver/v4 v4.0.0
- github.com/go-git/go-git/v5 v5.4.2
- github.com/kelseyhightower/envconfig v1.4.0
- github.com/mitchellh/mapstructure v1.3.1
- github.com/moby/buildkit v0.9.0
- gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c
- markdown-toc ^1.2.0
- sphinx *
- numpy >=1.19.1
- appdirs *
- configargparse *
- docutils *
- recommonmark *
- sphinx *
- sphinx-argparse *
- sphinx_rtd_theme *
- sphinxcontrib-napoleon *
- jekyll-feed ~> 0.6 development
- jekyll-paginate >= 0 development
- jekyll-sitemap >= 0 development
- kramdown >= 0
- kramdown-parser-gfm >= 0
- webrick >= 0
- actions/checkout v2 composite
- docker/login-action v1 composite
- actions/checkout v2 composite
- github/codeql-action/analyze v1 composite
- github/codeql-action/autobuild v1 composite
- github/codeql-action/init v1 composite
- JamesIves/github-pages-deploy-action 4.1.1 composite
- actions/checkout v2 composite
- actions/checkout v3 composite
- crate-ci/typos 592b36d23c62cb378f6097a292bc902ee73f93ef composite
- actions/checkout v2 composite
- vsoch/citelang/action/badge main composite
- vsoch/citelang/action/gen main composite
- ./action/badge * composite
- ./action/contrib * composite
- ./action/gen * composite
- actions/checkout v3 composite
- vsoch/citelang/action/gen main composite
- actions/checkout v2 composite
- con/tributors 0.0.20 composite
- vsoch/pull-request-action 1.0.12 composite
- ubuntu latest build
- black * development
- flake8 * development
- isort * development
- pre-commit * development