Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 1.97 KB

README.md

File metadata and controls

43 lines (32 loc) · 1.97 KB
Raw

refers

reference code simply

Tests

PyPI version

The refers library allows referencing plain text files from plain text files.

Usage:

  1. Add a @tag to the line that you want to reference: @tag:NAME
  2. To reference the tag use @ref followed by an optional option: @ref:NAME:OPTION
  3. run the refers library in the command line

The refers library will create new files with the outputted references in place of the tags. Changes of line placement, file name, relative path etc. are reflected in the updated references when the refers library is executed.

Installation

pip install refers

Reference Options

A reference has the following structure: @ref:NAME:OPTION. This will reference the named tag with the specified option. The available options are outlined in the table below.

Option Output
blank file name and line number
:file file name
:line line number
:link relative link to file
:linkline relative link to line in file
:fulllink full path link to file
:fulllinkline full path link to line in file
:quote quote line
:quotecode quote line of code without comment
:func get function name that contains line
:class get class name that contains line

Relative paths are given from the directory containing the pyproject.toml.

Future Work

Currently line continuation of code is only supported in python (using black). Future work will include supporting line continuation for all languages.