Science Score: 51.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
-
○DOI references
-
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
1 of 2 committers (50.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.2%) to scientific vocabulary
Keywords
Repository
Generate a citation file from Rust projects.
Basic Info
- Host: GitHub
- Owner: matbesancon
- License: mit
- Language: Rust
- Default Branch: master
- Size: 12.7 KB
Statistics
- Stars: 8
- Watchers: 1
- Forks: 4
- Open Issues: 1
- Releases: 0
Topics
Metadata Files
README.md
cargo-cite
A cargo extension to produce a citable BibTeX from crates
Installation
cargo-cite is not registered so you will need the following steps:
shell
git clone git@github.com:matbesancon/cargo-cite.git
cd cargo-cite
cargo install --path .
The command cargo cite will then be available.
Why
Citing software is important to acknowledge the work of others, but also because academic software development depends on it.
One pain point developers have is to find how to cite a given library.
One has to look in the README, documentation or some other file.
A recent experiment in the Julia community is to standardize
citations in one file at the top-level of projects, named CITATION.bib
with all the relevant BibTeX entries for the project.
Multiple entries can be added for different sub-topics related to the
software, as you can see in the Julia repo.
How does cargo-cite help
cargo-cite is an experimental Rust crate to generate a
CITATION.bib file for a Rust project based on its Cargo.toml file.
It can be yours or someone else's. Once the CITATION.bib file is created,
feel free to add other entries to it - for example, a software paper
published in the Journal of Open-Source Software.
Usage
Say you are using ndarray for your work, but they have not published a CITATION.bib yet:
$ git clone https://github.com/rust-ndarray/ndarray.git
$ cd ndarray
$ cargo cite
A CITATION.bib file has been created. To add the reference to this file
in the README, run:
$ cargo cite -r
Available options
See cargo cite --help for options.
Owner
- Name: Mathieu Besançon
- Login: matbesancon
- Kind: user
- Location: Grenoble, France
- Company: Zuse Institute Berlin
- Website: https://matbesancon.xyz
- Twitter: matbesancon
- Repositories: 169
- Profile: https://github.com/matbesancon
Researcher in mathematical optimization.
Citation (CITATION.bib)
@misc{cargo-cite,
title={{cargo-cite: a cargo extension to produce a citable BibTeX from crates}},
author={{Mathieu Besançon}},
month = 5,
year = 2019,
}
GitHub Events
Total
- Fork event: 1
Last Year
- Fork event: 1
Committers
Last synced: 8 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Mathieu Besançon | m****n@g****m | 14 |
| Anshul Singhvi | a****7@s****u | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 8 months ago
All Time
- Total issues: 3
- Total pull requests: 3
- Average time to close issues: almost 2 years
- Average time to close pull requests: 4 minutes
- Total issue authors: 2
- Total pull request authors: 2
- Average comments per issue: 1.0
- Average comments per pull request: 0.33
- Merged pull requests: 3
- 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
- albertsgarde (2)
- matbesancon (1)
Pull Request Authors
- matbesancon (3)
- asinghvi17 (1)