Skip to main content

Tool for parsing bibtex in ssau's format

Project description

Install

pip install references-parser

Usage

Use help to see CLI parameters

 python -m references_parser parse --help        
Usage: python -m references_parser parse [OPTIONS] PATH

Options:
  -s, --save TEXT         Path to file where to save the result of parsing.
  -p, --parser TEXT       Parser to use. Available parsers: ieee, ssau.
                          Default: ssau.
  -v, --verbose           Whether to print output to stdout or not
  -b, --beautify INTEGER  Number of line wraps between references. Default: 1
  --help                  Show this message and exit.

Usual way of using the script

python -m references_parser parse in.txt

Website references

It's hard to fully parse a website automatically, so some manual interactions are required.

How to add a website reference:

  1. Add the links directly to the input file.
  2. Invoke the prepare-urls command like this:
python -m references_parser prepare-urls in.txt
  1. Then, the URL in the file will be replaced with a BibTeX-annotated URL:
@online{Google,
    title={Google},
    date={18.05.2023},
    year={2023},
    origin={TODO: Author or place or corp here},
    base={TODO: Base resource title here},
    url={<https://google.com>}
}
  1. Here, you can fill in the fields origin (mandatory) and base with the required information.
  2. Then, you can use parsers as usual, but pay attention that the result contains [Б.м.], which you may want to delete.

Examples

Follow examples folder to see input and outputs file examples

Contribution

If you want to improve the program - just fork it and make a pool request

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

references_parser-1.1.0.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

references_parser-1.1.0-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file references_parser-1.1.0.tar.gz.

File metadata

  • Download URL: references_parser-1.1.0.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for references_parser-1.1.0.tar.gz
Algorithm Hash digest
SHA256 c50191139371d99fcca40097e974dad77ce4ccfe68867fa2066a330e213ab65a
MD5 2e4052aa1c610ea5f33258c3e08aedfa
BLAKE2b-256 1c5a91f70051ae8cfbd8a14e4aeeed97e6a8fc817b8fef8c02c054f4ce75a5fa

See more details on using hashes here.

File details

Details for the file references_parser-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for references_parser-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 75a7317af9e5df9cc460796a2007051f52aa19ac44541a640b7d84f385c446f1
MD5 036ec44505202cdc896bb919dfb112c9
BLAKE2b-256 1e07133bd0958a3883983cf6199c24462d70a2c8949048e11bb032587a0d7bd0

See more details on using hashes here.

Supported by

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