Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lambdacasserole/borganiser
A customisable script for organising and transforming BibTeX bibliographies.
https://github.com/lambdacasserole/borganiser
bibliography bibtex phd phd-thesis python utility
Last synced: 6 days ago
JSON representation
A customisable script for organising and transforming BibTeX bibliographies.
- Host: GitHub
- URL: https://github.com/lambdacasserole/borganiser
- Owner: lambdacasserole
- License: mit
- Created: 2020-07-02T09:48:41.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-15T17:21:24.000Z (5 months ago)
- Last Synced: 2024-10-10T22:14:56.069Z (27 days ago)
- Topics: bibliography, bibtex, phd, phd-thesis, python, utility
- Language: Python
- Homepage:
- Size: 22.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Borganiser
A customisable script for organising and transforming BibTeX bibliographies.
Borganiser is a lightweight, efficient utility designed to clean, sort, and organise BibTeX bibliographies. It's particularly useful for students and researchers looking to streamline their references in their theses or publications. With Borganiser, you can easily sort your BibTeX entries and their fields alphabetically, ensuring your bibliography is neatly formatted and consistently ordered.
## Features
- **Clean and Sort**: Strips unnecessary whitespace and sorts your BibTeX entries and fields.
- **User-friendly**: Simple interface, just run the script with your `.bib` file.
- **Customizable**: Easy to modify and adapt to your specific formatting rules.
## Installation
Clone the repository:
```
git clone https://github.com/lambdacasserole/borganiser.git
```
Navigate into the project directory:
```
cd borganiser
```
Borganiser is a Python-based utility. Ensure you have Python installed on your system. You can download and install Python from [python.org](https://www.python.org/).
## Usage
1. Place your `.bib` file in the same directory as the Borganiser script.
2. Run the script with your `.bib` file as input:
```
python borganiser.py main.bib
```
3. The script will print the sorted BibTeX entries to the console. You can redirect this output to a file:
```
python borganiser.py main.bib > sorted_main.bib
```
4. Replace your original `.bib` file with `sorted_main.bib` (or merge changes as needed).
## Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Saul Johnson - [@lambdacasserole](https://twitter.com/lambdacasserole)
Project Link: [https://github.com/lambdacasserole/borganiser](https://github.com/lambdacasserole/borganiser)