README.rst 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. pubmed-bibtex
  2. =============
  3. .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
  4. :target: https://github.com/psf/black
  5. .. image:: https://github.com/fphammerle/pubmed-bibtex/workflows/tests/badge.svg
  6. :target: https://github.com/fphammerle/pubmed-bibtex/actions
  7. .. image:: https://ipfs.io/ipfs/QmP8k5H4MkfspFxQxdL2kEZ4QQWQjF8xwPYD35KvNH4CA6/20230429T090002+0200/s3.amazonaws.com/assets.coveralls.io/badges/coveralls_100.svg
  8. :target: https://github.com/fphammerle/pubmed-bibtex/actions
  9. .. image:: https://img.shields.io/pypi/v/pubmed-bibtex.svg
  10. :target: https://pypi.org/project/pubmed-bibtex/#history
  11. .. image:: https://img.shields.io/pypi/pyversions/pubmed-bibtex.svg
  12. :target: https://pypi.org/project/pubmed-bibtex/
  13. Python Script & Module to Generate BibTeX Entries for PubMed
  14. Publications
  15. Utilizes the API of TeXMed, a BibTeX interface for PubMed.
  16. TeXMed was written by Arne Muller https://www.bioinformatics.org/texmed/
  17. pubmed-bibtex is currently unmaintained & archived cause TeXMed's exporter
  18. skips german umlaute & possibly other non-ascii characters
  19. (see `example <https://web.archive.org/web/20230512115423/https://www.bioinformatics.org/texmed/cgi-bin/list.cgi?PMID=31025164>`_)
  20. Install
  21. -------
  22. .. code:: sh
  23. pip3 install --user pubmed-bibtex
  24. Usage
  25. -----
  26. .. code:: sh
  27. $ pubmed-bibtex 31025164
  28. @Article{pmid31025164,
  29. Author="...",
  30. Title="...",
  31. Journal="...",
  32. ...
  33. }
  34. or
  35. .. code:: python
  36. from pubmed_bibtex import bibtex_entry_from_pmid
  37. print(bibtex_entry_from_pmid(123456789))
  38. Tests
  39. -----
  40. .. code:: sh
  41. pip3 install --user pipenv
  42. git clone https://github.com/fphammerle/pubmed-bibtex.git
  43. cd pubmed-bibtex
  44. pipenv run pylint freesurfer_surface
  45. pipenv run pytest --cov=freesurfer_surface