| Name | tidybib JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | |
| Summary | BibTeX formatter |
| upload_time | 2023-10-26 09:03:17 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | MIT License |
| keywords |
tex
latex
bibtex
formatter
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tidybib
**A BibTeX formatter, written in Python**
The `tidybib` command takes BibTeX input files and reformats their contents.
There is no configuration; everyone gets the same boring output.
## Installation
Install `tidybib` with pip:
pip install tidybib
Alternatively, you can run `tidybib` using [pipx](https://pypa.github.io/pipx/)
without installation:
pipx run tidybib
## Usage
Run `tidybib` on BibTex files `main.bib` and `aux.bib`:
tidybib main.bib aux.bib
After the command has run, the contents of `main.bib` and `aux.bib` have been
reformatted in place. Copies of the original files are kept under
`main.bib.untidy` and `aux.bib.untidy` -- these will be overwritten the next
time `tidybib` runs on changed input files.
You can also run `tidybib` on standard input:
cat main.bib aux.bib | tidybib
This will produce the formatted contents on standard output, and no files are
changed.
## Pre-commit hook
This repository contains a [pre-commit](https://pre-commit.com) hook to
automatically run `tidybib` when committing BibTeX files with git. To use the
hook, add this to the `repos` list in your `.pre-commit-config.yaml` file:
```yaml
- repo: https://github.com/ntessore/tidybib
rev: v0.1.3
hooks:
- id: tidybib
```
## Acknowledgements
All of the hard work of extracting a grammar and parser from the BibTeX source
code was done by [**aclements/biblib**](https://github.com/aclements/biblib).
Raw data
{
"_id": null,
"home_page": "",
"name": "tidybib",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "tex,latex,bibtex,formatter",
"author": "",
"author_email": "Nicolas Tessore <n.tessore@ucl.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/67/9d/bd3fcc58b26b78fa31af90efe6817dcd76b057fcfaee512c8d3811cb2337/tidybib-0.1.3.tar.gz",
"platform": null,
"description": "# tidybib\n\n**A BibTeX formatter, written in Python**\n\nThe `tidybib` command takes BibTeX input files and reformats their contents.\nThere is no configuration; everyone gets the same boring output.\n\n## Installation\n\nInstall `tidybib` with pip:\n\n pip install tidybib\n\nAlternatively, you can run `tidybib` using [pipx](https://pypa.github.io/pipx/)\nwithout installation:\n\n pipx run tidybib\n\n## Usage\n\nRun `tidybib` on BibTex files `main.bib` and `aux.bib`:\n\n tidybib main.bib aux.bib\n\nAfter the command has run, the contents of `main.bib` and `aux.bib` have been\nreformatted in place. Copies of the original files are kept under\n`main.bib.untidy` and `aux.bib.untidy` -- these will be overwritten the next\ntime `tidybib` runs on changed input files.\n\nYou can also run `tidybib` on standard input:\n\n cat main.bib aux.bib | tidybib\n\nThis will produce the formatted contents on standard output, and no files are\nchanged.\n\n## Pre-commit hook\n\nThis repository contains a [pre-commit](https://pre-commit.com) hook to\nautomatically run `tidybib` when committing BibTeX files with git. To use the\nhook, add this to the `repos` list in your `.pre-commit-config.yaml` file:\n\n```yaml\n- repo: https://github.com/ntessore/tidybib\n rev: v0.1.3\n hooks:\n - id: tidybib\n```\n\n## Acknowledgements\n\nAll of the hard work of extracting a grammar and parser from the BibTeX source\ncode was done by [**aclements/biblib**](https://github.com/aclements/biblib).\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "BibTeX formatter",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/ntessore/tidybib"
},
"split_keywords": [
"tex",
"latex",
"bibtex",
"formatter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fe4d12a83a21fa8929a4d8dee7bbd2ccc99b4e1059b0a8ba92632fb28c07e951",
"md5": "a4f933ca7c83d8933e60c4eec00542ef",
"sha256": "053101d6e73a254d8d0e82b916069946e9102b6339cfcb7d81276cd77c1f6599"
},
"downloads": -1,
"filename": "tidybib-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a4f933ca7c83d8933e60c4eec00542ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 11408,
"upload_time": "2023-10-26T09:03:16",
"upload_time_iso_8601": "2023-10-26T09:03:16.598150Z",
"url": "https://files.pythonhosted.org/packages/fe/4d/12a83a21fa8929a4d8dee7bbd2ccc99b4e1059b0a8ba92632fb28c07e951/tidybib-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "679dbd3fcc58b26b78fa31af90efe6817dcd76b057fcfaee512c8d3811cb2337",
"md5": "d9bb6b213c8b30927da3af97ff6f66bb",
"sha256": "0f33640610a3aa4241e17c4c79e311b949cd33050e340dad15d416d8d0c0ec87"
},
"downloads": -1,
"filename": "tidybib-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "d9bb6b213c8b30927da3af97ff6f66bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 10648,
"upload_time": "2023-10-26T09:03:17",
"upload_time_iso_8601": "2023-10-26T09:03:17.928689Z",
"url": "https://files.pythonhosted.org/packages/67/9d/bd3fcc58b26b78fa31af90efe6817dcd76b057fcfaee512c8d3811cb2337/tidybib-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-26 09:03:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ntessore",
"github_project": "tidybib",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tidybib"
}
