bibsync 0.3.1__tar.gz

bibsync-0.3.1/.gitignore

@@ -0,0 +1,136 @@
+# Generated by Cargo
+# will have compiled files and executables
+debug
+target
+dist
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.ruff_cache
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# Generated by cargo mutants
+# Contains mutation testing data
+**/mutants.out*/
+
+# RustRover
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# LaTeX build products generated while validating examples.
+examples/*.aux
+examples/*.bbl
+examples/*.blg
+examples/*.fdb_latexmk
+examples/*.fls
+examples/*.log
+examples/*.out
+examples/*.pdf
+examples/*.synctex.gz
+
+# Ad hoc provider output examples. The canonical checked fixtures are
+# examples/main.bib and examples/inspire-main.bib.
+examples/generated-*.bib
+
+site/
+
+*.so
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version

bibsync-0.3.1/.markdownlint.yaml

@@ -0,0 +1,7 @@
+default: true
+MD013:
+    line_length: 120
+    code_blocks: false
+    tables: false
+MD033: false
+MD041: false

bibsync-0.3.1/.pre-commit-config.yaml

@@ -0,0 +1,75 @@
+ci:
+    # pre-commit.ci does not install a Rust toolchain. Keep Cargo checks in
+    # GitHub Actions CI and run these hooks locally where rustup/cargo exist.
+    skip: [fmt, cargo-check, clippy]
+
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v6.0.0
+      hooks:
+          - id: check-added-large-files
+          - id: check-case-conflict
+          - id: check-merge-conflict
+          - id: check-symlinks
+          - id: check-yaml
+          - id: check-toml
+          - id: check-json
+          - id: end-of-file-fixer
+          - id: mixed-line-ending
+          - id: trailing-whitespace
+
+    - repo: https://github.com/doublify/pre-commit-rust
+      rev: v1.0
+      hooks:
+          - id: fmt
+            args: [--all]
+            pass_filenames: false
+          - id: cargo-check
+            pass_filenames: false
+          - id: clippy
+            args: [--all-targets, --all-features, --, -D, warnings]
+            pass_filenames: false
+
+    - repo: https://github.com/astral-sh/ruff-pre-commit
+      rev: v0.15.15
+      hooks:
+          - id: ruff
+            args: [--fix, --config=pyproject.toml]
+          - id: ruff-format
+
+    - repo: https://github.com/astral-sh/uv-pre-commit
+      rev: 0.11.17
+      hooks:
+          - id: uv-lock
+
+    - repo: https://github.com/rhysd/actionlint
+      rev: v1.7.12
+      hooks:
+          - id: actionlint
+
+    - repo: https://github.com/ComPWA/taplo-pre-commit
+      rev: v0.9.3
+      hooks:
+          - id: taplo-format
+
+    - repo: https://github.com/crate-ci/typos
+      rev: v1.47.0
+      hooks:
+          - id: typos
+            args: []
+
+    - repo: https://github.com/rbubley/mirrors-prettier
+      rev: v3.8.3
+      hooks:
+          - id: prettier
+
+    - repo: https://github.com/DavidAnson/markdownlint-cli2
+      rev: v0.22.1
+      hooks:
+          - id: markdownlint-cli2
+            args: [--config, .markdownlint.yaml]
+
+    - repo: https://github.com/gitleaks/gitleaks
+      rev: v8.30.1
+      hooks:
+          - id: gitleaks

bibsync-0.3.1/.pre-commit-hooks.yaml

@@ -0,0 +1,12 @@
+- id: bibsync
+  name: bibsync
+  description: Synchronize BibTeX entries from TeX citation keys
+  entry: bibsync
+  language: rust
+  types_or: [tex, bib]
+- id: bibsync-bin
+  name: bibsync
+  description: Synchronize BibTeX entries using a pre-built release binary
+  entry: scripts/pre-commit-bibsync
+  language: script
+  types_or: [tex, bib]

bibsync-0.3.1/.prettierrc

@@ -0,0 +1,5 @@
+{
+    "printWidth": 100,
+    "tabWidth": 4,
+    "useTabs": false
+}

bibsync-0.3.1/.typos.toml

@@ -0,0 +1,2 @@
+[default]
+extend-ignore-re = ["cafebabe"]

bibsync-0.3.1/CITATION.cff

@@ -0,0 +1,13 @@
+cff-version: 1.2.0
+title: "bibsync: A Rust package to automatically resolve, synchronize, and validate LaTeX citations across BibTeX databases"
+license: "BSD-3-Clause"
+type: software
+authors:
+    - given-names: Isaac C. F.
+      family-names: Wong
+      affiliation: KU Leuven
+      orcid: "https://orcid.org/0000-0003-2166-0027"
+keywords:
+    - rust
+    - github
+    - template

bibsync-0.3.1/CODE_OF_CONDUCT.md

@@ -0,0 +1,131 @@
+i# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at [INSERT CONTACT
+METHOD]. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

bibsync-0.3.1/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing to bibsync
+
+🎉 Thank you for your interest in contributing to `bibsync`.
+
+## Development
+
+1. Fork and clone the repository.
+2. Install the stable Rust toolchain with `rustup`.
+3. Install optional local tools:
+
+    ```shell
+    cargo install cargo-deny cargo-audit cargo-nextest git-cliff
+    pipx install pre-commit
+    ```
+
+4. Install hooks:
+
+    ```shell
+    pre-commit install
+    ```
+
+5. Run the local checks:
+
+    ```shell
+    cargo fmt --all --check
+    cargo clippy --all-targets --all-features -- -D warnings
+    cargo test --all-features
+    pytest
+    ```
+
+Use Conventional Commits for commit messages and pull request titles. The
+changelog is generated with `git-cliff`.
+
+## Licensing
+
+By contributing, you agree that your contributions will be licensed under the
+project's 3-Clause BSD License.