Science Score: 75.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 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
✓Institutional organization owner
Organization cu-dbmi has institutional domain (medschool.cuanschutz.edu) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.3%) to scientific vocabulary
Repository
A pre-commit check for semantic line breaks.
Basic Info
- Host: GitHub
- Owner: CU-DBMI
- License: bsd-3-clause
- Language: Python
- Default Branch: main
- Size: 104 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
- Releases: 3
Metadata Files
README.md
onesentence
A Pre-commit hook for checking 'one sentence per line' documentation practices.
One sentence per line is a practice where developers use only one line per sentence.
This can make it easier to review or provide comments on in version control systems like git.
That said, it can sometimes be difficult to remember or "debug" this style preference.
We provide this linting tool to assist with finding and fixing areas of content where the style preference is one sentence per line.
Usage
The onesentence tool provides a command-line interface for checking and fixing files to ensure they follow the "one sentence per line" rule.
Commands
bash
onesentence check <file_path>
This command checks if the specified file adheres to the "one sentence per line" rule. It will return a non-zero exit code if any violations are found.
bash
onesentence fix <file_path> [<dest_path>]
This command corrects the specified file by splitting lines with multiple sentences into separate lines. If a dest_path is provided, the corrected file will be written to that path; otherwise, the original file will be overwritten.
Pre-commit
Install this pre-commit hook into your project with a block like the following:
yaml
repos:
- repo: https://github.com/CU-DBMI/onesentence
rev: v0.0.1
hooks:
# run checks
- id: check
# run checks and fixes where possible
- id: fix
Owner
- Name: University of Colorado Department of Biomedical Informatics
- Login: CU-DBMI
- Kind: organization
- Location: University of Colorado, School of Medicine, Anschutz Medical Campus
- Website: https://medschool.cuanschutz.edu/dbmi
- Repositories: 34
- Profile: https://github.com/CU-DBMI
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: onesentence
message: >-
If you use this software, please cite it using the
metadata from the CITATION.cff file.
type: software
authors:
- given-names: David
family-names: Bunten
orcid: "https://orcid.org/0000-0001-6041-3665"
repository-code: "https://github.com/CU-DBMI/onesentence"
abstract: >-
A Pre-commit hook for checking 'one sentence per line' documentation practices.
keywords:
- python
- documentation
- style
- one-sentence-per-line
- formatter
- linting
license: BSD-3-Clause
identifiers:
- type: doi
value: "10.5281/zenodo.15521186"
GitHub Events
Total
- Delete event: 1
- Push event: 1
- Pull request review event: 1
- Pull request event: 2
- Create event: 1
Last Year
- Delete event: 1
- Push event: 1
- Pull request review event: 1
- Pull request event: 2
- Create event: 1
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 0
- Total pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: about 7 hours
- Total issue authors: 0
- Total pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 2
Past Year
- Issues: 0
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: about 7 hours
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 2
Top Authors
Issue Authors
Pull Request Authors
- dependabot[bot] (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 15 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 1
- Total maintainers: 1
pypi.org: onesentence
A Pre-commit hook for 'one sentence per line' documentation practices.
- Documentation: https://onesentence.readthedocs.io/
- License: bsd-3-clause
-
Latest release: 0.0.3
published 9 months ago