Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 2.57 KB

README.md

File metadata and controls

74 lines (52 loc) · 2.57 KB
Raw

FIX2json

PyPI - Version PyPI - License

FIX2json is a FIX Dictionary generator tool.

The program performs data enhancing and data sanitazion on raw FIX Repository files. It allows you to The resulting data will feature:

  • High-quality Markdown documentation obtained from several sources, plus minor improvements, e.g.
    • links to ISO standards,
    • RFC 2119 terms capitalization,
    • links for internal navigation,
    • markup, bold text, etc.
  • Embedded documentation strings (instead of separate files, like the original FIX Repository).
  • Full breakdown into fields and components.
  • Information about included Extension Packs.
  • General cleanup and improved data consistency across all FIX protocol versions.

Developers working with the FIX Protocol can really benefit from higher-quality JSON (rather than clunky XML) sources to use for code generation, data explorations, and so on.

In short, FIX2json makes it much easier to work with the FIX protocol.

How to use

First, you must install FIX2json:

$ pip3 install fix2json

You can now type fix2json --help for thorough usage information. Here's an example:

$ fix2json --improve-docs=1 fix_repository/Unified/ empty/
Written to 'empty/fix-4-0.json'.
Written to 'empty/fix-4-1.json'.
Written to 'empty/fix-4-2.json'.
Written to 'empty/fix-4-3.json'.
Written to 'empty/fix-4-4.json'.
Written to 'empty/fix-5-0.json'.
Written to 'empty/fix-5-0-sp1.json'.
Written to 'empty/fixt-1-1.json'.
Written to 'empty/fix-5-0-sp2.json'.

You can also install from source:

$ git clone [email protected]:fixipe/fix2json.git
$ pip3 install -e fix2json

Codebase tour

Main application code is inside fix2json/. empty/ was introduced as a handy, catch-all target directory for test runs.

resources/errata contains random Fix Repository errata in JSON format. It is not complete. You should always prefer updating this repository rather than making manual fixes to output files. tools/ contains web crawlers for FixTrading.org. This allows for automatical download of EP definition files and other useful resources.

Contributing

# Setup poetry
$ pip install poetry
$ poetry install

# Test your changes
$ poetry run fix2json --help

# Useful scripts for local development
$ poetry run python scripts/ep_page_to_links.py ...

License

Copyright (c) 2020, Filippo Costa. This software is released under the terms of Apache License 2.