Skip to main content

A Python package to check whether papers in your .bib file have been listed on Retraction Watch

Project description

retraction_check

Tests Code Quality Build

A Python package to check whether papers in your .bib file or a specific bibtex entry have been listed on Retraction Watch.

Features

  • Parse .bib files and extract paper information
  • Query the Retraction Watch dataset for retracted papers
  • Support both exact DOI matching and fuzzy title matching
  • Robust error handling for various edge cases

Installation

# Install from PyPI (when published)
pip install retraction-check

# Or install from source
git clone https://github.com/codingfabi/retraction_check.git
cd retraction_check
pipenv install

# Install development dependencies
pipenv install --dev

Usage

Command line

# Using the installed command
retraction-check yourfile.bib

# Or using the module
python -m retraction_check.check_bib yourfile.bib

Development

Running tests

# Run all tests
pipenv run test

# Run tests with coverage
pipenv run test-cov

# Run tests in watch mode
pipenv run test-watch

# Run tests directly with Python
python tests/run_tests.py

Code quality

# Format code
pipenv run format

# Lint code
pipenv run lint

# Type checking
pipenv run type-check

# Run all checks
pipenv run check-all

Available test commands

  • test - Run all tests with verbose output
  • test-cov - Run tests with coverage report (HTML and terminal)
  • test-watch - Run tests in watch mode with short traceback
  • lint - Run flake8 linting
  • format - Format code with black
  • format-check - Check if code is properly formatted
  • type-check - Run mypy type checking
  • check-all - Run all quality checks (format, lint, type-check, test-cov)

Requirements

  • Python 3.8+
  • bibtexparser
  • requests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

retraction_check-0.1.0.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

retraction_check-0.1.0-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file retraction_check-0.1.0.tar.gz.

File metadata

  • Download URL: retraction_check-0.1.0.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for retraction_check-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2b7a327e79c78b54d55bef7ad968be4ebd00b7e1cbc8bb8590bcc7eb797bddaa
MD5 c18fd515054cb00fc055b8dea688b570
BLAKE2b-256 137ecf382ea13840c90849705618b16a6f921854ff4dbf677776c9e6a2e33749

See more details on using hashes here.

Provenance

The following attestation bundles were made for retraction_check-0.1.0.tar.gz:

Publisher: build.yml on codingfabi/retraction_check

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file retraction_check-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for retraction_check-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6c24fd2174963bfba4468ffd027674e548f96f8cc207d17a4a7b6ffae4248d8d
MD5 fd7bb3cba40491e65988567a6a8f5277
BLAKE2b-256 96d761d15a70a6065f4d1f1c44e7269155afae6ce6a480871c809e7b3f4a3f43

See more details on using hashes here.

Provenance

The following attestation bundles were made for retraction_check-0.1.0-py3-none-any.whl:

Publisher: build.yml on codingfabi/retraction_check

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page