https://github.com/rapmd73/fixtodict

A smart FIX Dictionary generator tool.
https://github.com/rapmd73/fixtodict

Last synced: about 1 month ago
JSON representation

A smart FIX Dictionary generator tool.

• Host: GitHub
• URL: https://github.com/rapmd73/fixtodict
• Owner: rapmd73
• License: apache-2.0
• Created: 2022-08-14T21:51:25.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2020-04-07T23:06:59.000Z (about 5 years ago)
• Last Synced: 2025-02-01T15:44:25.891Z (3 months ago)
• Size: 127 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# FIXtodict

![PyPI - Version](https://img.shields.io/pypi/v/fixtodict)

![PyPI - License](https://img.shields.io/pypi/l/fixtodict)

FIXtodict 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, FIXtodict makes it much easier to work with the FIX protocol.

## How to use

First, you must install FIXtodict:

    $ pip3 install fixtodict

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

    $ fixtodict --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/fixtodict.git

    $ pip3 install -e fixtodict

## Codebase tour

Main application code is inside `fixtodict/`. `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](https://fixtrading.org). This allows for automatical download of EP definition files and other useful resources.

## License

Copyright (c) 2020, Filippo Costa. This software is released under the terms of [Apache License 2](https://www.apache.org/licenses/LICENSE-2.0.txt).