Skip to main content

"A Python tool that scrapes your footnotes in any Word doc and builds a bibliography so you don't have to"

Project description

Footnotes2Biblio Version Dev License MIT Contributions Welcome

Footnotes2Biblio creates a bibliography page from the footnotes in any .docx document. Great for academics who don't want to scroll through hundreds of pages trying to track down every single source.

Table of Contents

  1. Key features
  2. Download
  3. How to use
  4. Notes and other TODOs & FIXMEs
  5. Credits
  6. Licence
  7. Socials

Key features

  • Lightweight and relatively easy to use
  • Citation-style agnostic. Should work on most style guide.
  • Simple syntax structure for marking in your doc what footnotes should be scraped. (E.g., {f mono 2}[citation]{/f})
  • Saves you hours of scrolling back and forth trying to track down every. single. citation.

Download

Easiest way to download is to open your Terminal and type in the following: python3 -m pip install footnotes2biblio. All necessary files will be installed onto your machine.

How to use

  1. Set up your document to be scraped. Use the following syntax in your footnote sections to mark what should be scraped ('#' indicates the number of authors):
(f mono #} ... {/f} for monographs/books.
{f journo #} ... {/f} for journals/articles.
{f online #} ... {/f} for online or other sources.
{f juris} ... {/f} for court cases and other jurisprudence. No number argument required
{f legis} ... {/f} for legislation sources. No number argument required.

Note: it is recommended you make a backup of the document your are scaping. Safety first.
  1. When you've marked your document, open your terminal again and type in f2b src dst where src is the path of the document you want scraped and dst is the document name of your soon to be bibliography. (E.g., f2b /Users/acour008/desktop/thesis.docx /Users/acour008/biblio.docx)
  2. Thats it! Now you get to marvel at the beauty and ease of it.

TODOs & FIXMEs

Notes:

  • This was scripted with McGill Legal Citation (8th ed) in mind, but it is still style agnostic as long as the author names are separated from the title with a comma (,).
  • For best results, do not add whitespaces between {f}...{/f} tags.
  • Again, make a back up of your work. I am not responsible for any unintended loss of data or written work.

TODOs:

  • Add a type attribute to the Footnote class so instead of 4 different footnote lists and parsers, one parser can find the regex patterns necessary to match the sources and stuff into one list. This will make it easier to sort and print to a new document.

Credits

This software uses the following:

Licence

MIT

Socials

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

footnotes2biblio-0.0.2a0.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

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

footnotes2biblio-0.0.2a0-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file footnotes2biblio-0.0.2a0.tar.gz.

File metadata

  • Download URL: footnotes2biblio-0.0.2a0.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.2

File hashes

Hashes for footnotes2biblio-0.0.2a0.tar.gz
Algorithm Hash digest
SHA256 31aae69e9f6196b8b881395d435ebc5c8c486f7f7c20bfd09babe6548a8b993b
MD5 778a3c2096fe240ec0d48ad5e02c935b
BLAKE2b-256 63c8c69181f9055e192fc6a6057164ee76b761c4ef2d959237bcf934baa2486d

See more details on using hashes here.

File details

Details for the file footnotes2biblio-0.0.2a0-py3-none-any.whl.

File metadata

  • Download URL: footnotes2biblio-0.0.2a0-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.2

File hashes

Hashes for footnotes2biblio-0.0.2a0-py3-none-any.whl
Algorithm Hash digest
SHA256 b061f0c290f8991980bda590096a735bb5eec38605e641065c6625b7d0b99fed
MD5 1c702f82261e6b2878b8abc7d22a6577
BLAKE2b-256 148a7fbd03c747f7bed574b311b9734dc81072877cb53702caeb2fada9be2318

See more details on using hashes here.

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