improve CLI and switch to Poetry

ferrumfix · Sep 28, 2022 · 5706c3a · 5706c3a
1 parent 0d19a62
commit 5706c3a
Show file tree

Hide file tree

Showing 84 changed files with 1,500 additions and 780 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
-# FIX2dict
+# FIX2json
 
-![PyPI - Version](https://img.shields.io/pypi/v/fix2dict)
-![PyPI - License](https://img.shields.io/pypi/l/fix2dict)
+![PyPI - Version](https://img.shields.io/pypi/v/fix2json)
+![PyPI - License](https://img.shields.io/pypi/l/fix2json)
 
-FIX2dict is a FIX Dictionary generator tool.
+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:
 
@@ -22,17 +22,17 @@ The program performs data enhancing and data sanitazion on raw FIX Repository fi
 
 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, FIX2dict makes it much easier to work with the FIX protocol.
+In short, FIX2json makes it much easier to work with the FIX protocol.
 
 ## How to use
 
-First, you must install FIX2dict:
+First, you must install FIX2json:
 
-    $ pip3 install fix2dict
+    $ pip3 install fix2json
 
-You can now type `fix2dict --help` for thorough usage information. Here's an example:
+You can now type `fix2json --help` for thorough usage information. Here's an example:
 
-    $ fix2dict --improve-docs=1 fix_repository/Unified/ empty/
+    $ 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'.
@@ -45,16 +45,30 @@ You can now type `fix2dict --help` for thorough usage information. Here's an exa
 
 You can also install from source:
 
-    $ git clone [email protected]:fixipe/fix2dict.git
-    $ pip3 install -e fix2dict
+    $ git clone [email protected]:fixipe/fix2json.git
+    $ pip3 install -e fix2json
 
 ## Codebase tour
 
-Main application code is inside `fix2dict/`. `empty/` was introduced as a handy, catch-all target directory for test runs.
+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](https://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](https://www.apache.org/licenses/LICENSE-2.0.txt).
+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).
diff --git a/docs/unveiling-fixtodict.md b/docs/unveiling-fixtodict.md
@@ -1,7 +1,7 @@
 Hello!
-I would like to unveil a project I've been working on for the last couple of weeks. It's fully open source and you can check it out [here](https://github.com/fixipe/fix2dict/).
+I would like to unveil a project I've been working on for the last couple of weeks. It's fully open source and you can check it out [here](https://github.com/fixipe/fix2json/).
 
-When I started working on FIX2dict, I set out to dramatically improve the state of the art for programmatic access to FIX Repository data. This is made possible by adopting the widespread JSON data format, as well as two other popular web standards:
+When I started working on FIX2json, I set out to dramatically improve the state of the art for programmatic access to FIX Repository data. This is made possible by adopting the widespread JSON data format, as well as two other popular web standards:
 
 1. JSON Schema.
 2. JSON Patch.
@@ -11,21 +11,21 @@ FIX Repository has traditionally been released as XML files, but XML itself is m
 * You often need third-party, poorly-supported libraries to work with XML. In recent years (decades, actually), most APIs and tools have switched to less verbose and more ubiquitous data formats.
 * JSON is extremely popular and benefits from a huge range of existing tooling.
 
-Hopefully, I have made my case clear for considering the JSON ecosystem over XML for FIX Repository. As a proof of concept, I am releasing FIX2dict.
+Hopefully, I have made my case clear for considering the JSON ecosystem over XML for FIX Repository. As a proof of concept, I am releasing FIX2json.
 
-# Introduction to FIX2dict
+# Introduction to FIX2json
 
-FIX2dict is a collection of related tools to read, update, modify FIX Repository data. First and foremost, it allows you to transform original FIX Repository data (i.e. `.xml`) into JSON. A standard-compliant [JSON Schema](https://json-schema.org/) description describes the format of produced data. This way, a lot of jobs can become much easier:
+FIX2json is a collection of related tools to read, update, modify FIX Repository data. First and foremost, it allows you to transform original FIX Repository data (i.e. `.xml`) into JSON. A standard-compliant [JSON Schema](https://json-schema.org/) description describes the format of produced data. This way, a lot of jobs can become much easier:
 
-- Code generation. FIX2dict supersedes software like [`fix-repository-to-quickfix-xml`](https://code.google.com/archive/p/fix-repository-to-quickfix-xml/).
+- Code generation. FIX2json supersedes software like [`fix-repository-to-quickfix-xml`](https://code.google.com/archive/p/fix-repository-to-quickfix-xml/).
 - Documentation generation. Programmatic generation of both high-quality documentation files (in formats like `.pdf`, `.doc`) and browser-oriented tools becomes much easier. A proof of concept is currently in the works.
 
 # About Extension Packs
 
-FIX2dict can also transform EP files (`.xml`) into a [JSON Patch](https://tools.ietf.org/html/rfc6902) file. We can leverage JSON Patch -already standardized by W3C- to completely remove the need for XSLT scripts and DDT
+FIX2json can also transform EP files (`.xml`) into a [JSON Patch](https://tools.ietf.org/html/rfc6902) file. We can leverage JSON Patch -already standardized by W3C- to completely remove the need for XSLT scripts and DDT
 
 # Conclusions
 
 I welcome feedback and I remain available for further clarifications. You can contact me at my personal email address [`[email protected]`](mailto:[email protected]). Hopefully members of the FIX Trading Community will see this as a great opportunity for lowering the barrier of access to the FIX Repository, which is at the heart of any serious tool for FIX.
 
-Finally, just as a powerful example of what can be readily achieved with high-quality FIX Repository data, you can have a look at [fixipe.com](https://fixipe.com). It was built leveraging FIX2dict's features and, with some more work, it could work great not only as online FIX Dictionary but also as editor, allowing people to create custom EPs and then export them in multiple formats.
+Finally, just as a powerful example of what can be readily achieved with high-quality FIX Repository data, you can have a look at [fixipe.com](https://fixipe.com). It was built leveraging FIX2json's features and, with some more work, it could work great not only as online FIX Dictionary but also as editor, allowing people to create custom EPs and then export them in multiple formats.
diff --git a/fix2dict/__init__.py b/fix2dict/__init__.py
diff --git a/fix2dict/__version__.py b/fix2dict/__version__.py
diff --git a/fix2dict/cli/__init__.py b/fix2dict/cli/__init__.py
diff --git a/fix2dict/cli/convert_ep.py b/fix2dict/cli/convert_ep.py
diff --git a/fix2dict/cli/convert_repo.py b/fix2dict/cli/convert_repo.py
diff --git a/fix2dict/cli/filter_patch.py b/fix2dict/cli/filter_patch.py
diff --git a/fix2dict/cli/jsonpatch.py b/fix2dict/cli/jsonpatch.py
diff --git a/fix2dict/cli/main.py b/fix2dict/cli/main.py
diff --git a/fix2dict/cli/review.py b/fix2dict/cli/review.py
diff --git a/fix2dict/cli/schema.py b/fix2dict/cli/schema.py
diff --git a/fix2dict/cli/utils/json.py b/fix2dict/cli/utils/json.py
diff --git a/fix2dict/cli/xref.py b/fix2dict/cli/xref.py
diff --git a/fix2dict/formats/__init__.py b/fix2dict/formats/__init__.py