Welcome to BibDeskParser’s documentation!
BibDeskParser is a Python library for working with BibDesk (.bib) database files.
Overview
How-to Guides
- How-to Guides
- How to manage file attachments
- How to auto-file attachments
- How to reconcile attachments against a folder of PDFs
- How to track companion (asset) files
- How to define or rename a
@stringmacro (journal abbreviation) - How to organize entries into groups
- How to tag entries with keywords
- How to store database-level metadata (document info)
- How to search a library
- How to find and resolve duplicate citation keys
- How to automatically generate citation keys
- How to add a reference from a DOI, arXiv ID, or search query
- How to fill in missing abstracts
- How to fill in missing arXiv identifiers
- How to fill in missing DOIs
- How to manage preprint-only publications
- How to import BibTeX entries from a publisher or another library
- How to edit an entry in your text editor
- How to render a bibliography in a specific citation format
- How to give an AI coding agent access to your library
- How to export a minimal BibTeX file for LaTeX
- How to manage an exported
.bibfile
Explanation
- BibDesk's .bib Format
- The file header
- Document info (the
@bibdesk_infoblock) date-addedanddate-modified- Linked files (
bdsk-file-Nfields) - Linked URLs (
bdsk-url-Nfields) @stringmacros and journal abbreviations- BibDesk Static Groups
- BibDesk Smart Groups
- Empty fields
- Keywords
- Unicode and TeX-escaped characters
- Duplicate citation keys
- Byte-exact round-tripping
- The plain format of exported files
- Preprints
- External Assets
Reference
- Bib Entry Types
- Configuration
- Where the file is found
- The
default_bib_fileoption - The
verify_typesandverify_fieldsflags - The
[auto_key]table: autogenerated citation keys - The
[auto_file]table: autogenerated attachment file names - The
[assets]table: companion asset files - The
[add]and[add_abstract]tables: fetching defaults - The
[rekey]and[delete]tables: file lifecycle defaults - The
[known_missing]table: known-missing groups - The
[initials]table: acronym exceptions - The
[journal_macros]table: journal-name-to-macro mappings - The
[preprint_archives]table: recognized preprint servers - The
preprint_exportoption - The
protected_wordslist - Custom and extended entry types
- Custom fields
- A complete example
- Format Specifiers
- CLI
- Package API
Development