python-hcl2 7.3.1__tar.gz → 8.0.0rc2__tar.gz

python_hcl2-8.0.0rc2/.coveragerc

@@ -0,0 +1,15 @@
+[run]
+branch = true
+omit =
+    hcl2/lark_parser.py
+    hcl2/version.py
+    hcl2/__main__.py
+    hcl2/__init__.py
+    hcl2/rules/__init__.py
+    cli/__init__.py
+
+[report]
+show_missing = true
+fail_under = 95
+exclude_lines =
+    raise NotImplementedError

{python_hcl2-7.3.1 → python_hcl2-8.0.0rc2}/.github/ISSUE_TEMPLATE/hcl2-parsing-error.md

@@ -1,27 +1,31 @@
----
+______________________________________________________________________
+
 name: HCL2 parsing error
 about: Template for reporting a bug related to parsing HCL2 code
 title: ''
 labels: bug
 assignees: kkozik-amplify
 
----
+______________________________________________________________________
 
 **Describe the bug**
 
 A clear and concise description of what the bug is.
 
 **Software:**
- - OS: [macOS / Windows / Linux]
- - Python version (e.g. 3.9.21)
- - python-hcl2 version (e.g. 7.0.0)
+
+- OS: \[macOS / Windows / Linux\]
+- Python version (e.g. 3.9.21)
+- python-hcl2 version (e.g. 7.0.0)
 
 **Snippet of HCL2 code causing the unexpected behaviour:**
+
 ```terraform
 locals {
   foo = "bar"
 }
 ```
+
 **Expected behavior**
 
 A clear and concise description of what you expected to happen, e.g. python dictionary or JSON you expected to receive as a result of parsing.

{python_hcl2-7.3.1 → python_hcl2-8.0.0rc2}/.github/workflows/codeql-analysis.yml

@@ -13,7 +13,7 @@ on:
 jobs:
   analyse:
     name: Analyse
-    runs-on: ubuntu-latest
+    runs-on: github-hosted-static-ip
 
     steps:
       - name: Checkout repository

{python_hcl2-7.3.1 → python_hcl2-8.0.0rc2}/.github/workflows/dependencies_check.yml

@@ -14,7 +14,7 @@ on:
 jobs:
   test:
     name: Check dependencies sync between pyproject.toml and requirements.txt
-    runs-on: ubuntu-22.04
+    runs-on: github-hosted-static-ip
     steps:
       - uses: actions/checkout@master
       - name: Set up Python 3.13

{python_hcl2-7.3.1 → python_hcl2-8.0.0rc2}/.github/workflows/pr_check.yml

@@ -10,10 +10,10 @@ on:
 jobs:
   test:
     name: Check code against linter/unit tests
-    runs-on: ubuntu-22.04
+    runs-on: github-hosted-static-ip
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
     steps:
       - uses: actions/checkout@master
       - name: Set up Python ${{ matrix.python-version }}

{python_hcl2-7.3.1 → python_hcl2-8.0.0rc2}/.github/workflows/publish.yml

@@ -2,12 +2,12 @@
 name: Publish
 on:
   release:
-    types: [released]
+    types: [published]
 
 jobs:
   build-publish:
     name: Build and publish Python distributions
-    runs-on: ubuntu-22.04
+    runs-on: github-hosted-static-ip
     steps:
       - uses: actions/checkout@master
       - name: Set up Python

python_hcl2-8.0.0rc2/.github/workflows/security.yml

@@ -0,0 +1,23 @@
+---
+name: Security Review
+
+permissions:
+  pull-requests: write  # Needed for leaving PR comments
+  contents: read
+
+on:
+  pull_request:
+
+jobs:
+  security:
+    runs-on: github-hosted-static-ip
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha || github.sha }}
+          fetch-depth: 2
+
+      - uses: anthropics/claude-code-security-review@main
+        with:
+          comment-pr: true
+          claude-api-key: ${{ secrets.ANTHROPIC_CLAUDE_API_KEY }}

{python_hcl2-7.3.1 → python_hcl2-8.0.0rc2}/.pre-commit-config.yaml

@@ -6,6 +6,7 @@ repos:
     rev: v4.3.0
     hooks:
       - id: trailing-whitespace
+        exclude: ^test/integration/(hcl2_reconstructed|specialized)/
       - id: end-of-file-fixer
       - id: check-added-large-files
       - id: no-commit-to-branch  # Prevent commits directly to master

{python_hcl2-7.3.1 → python_hcl2-8.0.0rc2}/CHANGELOG.md

@@ -9,6 +9,37 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Nothing yet.
 
+## \[8.0.0\] - rc2
+
+### Added
+
+- Full architecture overhaul: bidirectional HCL2 ↔ JSON pipeline with typed rule classes. ([#203](https://github.com/amplify-education/python-hcl2/pull/203))
+  - add function tuples round-trip test suite ([#268](https://github.com/amplify-education/python-hcl2/pull/268))
+  - Add postlexer to support multiline binary operators and ternary expressions ([#270](https://github.com/amplify-education/python-hcl2/pull/270))
+  - more robust whitespace handling in reconstruction ([#271](https://github.com/amplify-education/python-hcl2/pull/271))
+  - SerializationOptions - add an option to strip string quotes in dict/JSON output ([#272](https://github.com/amplify-education/python-hcl2/pull/272))
+- CLAUDE.md ([#260](https://github.com/amplify-education/python-hcl2/pull/260))
+
+### Fixed
+
+- Ternary with strings parse error ([#55](https://github.com/amplify-education/python-hcl2/issues/55))
+- "No terminal matches '|' in the current parser context" when parsing multi-line conditional ([#142](https://github.com/amplify-education/python-hcl2/issues/142))
+- reverse_transform not working with object-type variables ([#231](https://github.com/amplify-education/python-hcl2/issues/231))
+- reverse_transform not handling nested functions ([#235](https://github.com/amplify-education/python-hcl2/issues/235))
+- `writes` omits quotes around map keys with `/` ([#236](https://github.com/amplify-education/python-hcl2/issues/236))
+- Operator precedence bug ([#248](https://github.com/amplify-education/python-hcl2/issues/248))
+- Empty string dictionary keys can't be parsed twice ([#249](https://github.com/amplify-education/python-hcl2/issues/249))
+- jsonencode not deserialized correctly ([#250](https://github.com/amplify-education/python-hcl2/issues/250))
+- Literal string "string" incorrectly quoted ([#251](https://github.com/amplify-education/python-hcl2/issues/251))
+- Interpolation literals added to locals/variables in maps ([#252](https://github.com/amplify-education/python-hcl2/issues/252))
+- Object literal expression can't be serialized ([#253](https://github.com/amplify-education/python-hcl2/issues/253))
+- Heredocs should interpret backslash literally ([#262](https://github.com/amplify-education/python-hcl2/issues/262))
+- Parsing a multi-line multi-conditional expression causes exception - Unexpected token Token('QMARK', '?') ([#269](https://github.com/amplify-education/python-hcl2/issues/269))
+
+### Changed
+
+- Updated package metadata: development status, dropped Python 3.7 support. ([#263](https://github.com/amplify-education/python-hcl2/pull/263))
+
 ## \[7.3.1\] - 2025-07-24
 
 ### Fixed

python_hcl2-8.0.0rc2/CLAUDE.md

@@ -0,0 +1,144 @@
+# HCL2 Parser — CLAUDE.md
+
+## Pipeline
+
+```
+Forward:  HCL2 Text → [PostLexer] → Lark Parse Tree → LarkElement Tree → Python Dict/JSON
+Reverse:  Python Dict/JSON → LarkElement Tree → Lark Tree → HCL2 Text
+Direct:   HCL2 Text → [PostLexer] → Lark Parse Tree → LarkElement Tree → Lark Tree → HCL2 Text
+```
+
+The **Direct** pipeline (`parse_to_tree` → `transform` → `to_lark` → `reconstruct`) skips serialization to dict, so all IR nodes (including `NewLineOrCommentRule` nodes for whitespace/comments) directly influence the reconstructed output. Any information discarded before the IR is lost in this pipeline.
+
+## Module Map
+
+| Module | Role |
+|---|---|
+| `hcl2/hcl2.lark` | Lark grammar definition |
+| `hcl2/api.py` | Public API (`load/loads/dump/dumps` + intermediate stages) |
+| `hcl2/postlexer.py` | Token stream transforms between lexer and parser |
+| `hcl2/parser.py` | Lark parser factory with caching |
+| `hcl2/transformer.py` | Lark parse tree → LarkElement tree |
+| `hcl2/deserializer.py` | Python dict → LarkElement tree |
+| `hcl2/formatter.py` | Whitespace alignment and spacing on LarkElement trees |
+| `hcl2/reconstructor.py` | LarkElement tree → HCL2 text via Lark |
+| `hcl2/builder.py` | Programmatic HCL document construction |
+| `hcl2/utils.py` | `SerializationOptions`, `SerializationContext`, string helpers |
+| `hcl2/const.py` | Constants: `IS_BLOCK`, `COMMENTS_KEY`, `INLINE_COMMENTS_KEY` |
+| `cli/helpers.py` | File/directory/stdin conversion helpers |
+| `cli/hcl_to_json.py` | `hcl2tojson` entry point |
+| `cli/json_to_hcl.py` | `jsontohcl2` entry point |
+
+`hcl2/__main__.py` is a thin wrapper that imports `cli.hcl_to_json:main`.
+
+### Rules (one class per grammar rule)
+
+| File | Domain |
+|---|---|
+| `rules/abstract.py` | `LarkElement`, `LarkRule`, `LarkToken` base classes |
+| `rules/tokens.py` | `StringToken` (cached factory), `StaticStringToken`, punctuation constants |
+| `rules/base.py` | `StartRule`, `BodyRule`, `BlockRule`, `AttributeRule` |
+| `rules/containers.py` | `TupleRule`, `ObjectRule`, `ObjectElemRule`, `ObjectElemKeyRule` |
+| `rules/expressions.py` | `ExprTermRule`, `BinaryOpRule`, `UnaryOpRule`, `ConditionalRule` |
+| `rules/literal_rules.py` | `IntLitRule`, `FloatLitRule`, `IdentifierRule`, `KeywordRule` |
+| `rules/strings.py` | `StringRule`, `InterpolationRule`, `HeredocTemplateRule` |
+| `rules/functions.py` | `FunctionCallRule`, `ArgumentsRule` |
+| `rules/indexing.py` | `GetAttrRule`, `SqbIndexRule`, splat rules |
+| `rules/for_expressions.py` | `ForTupleExprRule`, `ForObjectExprRule`, `ForIntroRule`, `ForCondRule` |
+| `rules/whitespace.py` | `NewLineOrCommentRule`, `InlineCommentMixIn` |
+
+## Public API (`api.py`)
+
+Follows the `json` module convention. All option parameters are keyword-only.
+
+- `load/loads` — HCL2 text → Python dict
+- `dump/dumps` — Python dict → HCL2 text
+- Intermediate stages: `parse/parses`, `parse_to_tree/parses_to_tree`, `transform`, `serialize`, `from_dict`, `from_json`, `reconstruct`
+
+### Option Dataclasses
+
+**`SerializationOptions`** (LarkElement → dict):
+`with_comments`, `with_meta`, `wrap_objects`, `wrap_tuples`, `explicit_blocks`, `preserve_heredocs`, `force_operation_parentheses`, `preserve_scientific_notation`
+
+**`DeserializerOptions`** (dict → LarkElement):
+`heredocs_to_strings`, `strings_to_heredocs`, `object_elements_colon`, `object_elements_trailing_comma`
+
+**`FormatterOptions`** (whitespace/alignment):
+`indent_length`, `open_empty_blocks`, `open_empty_objects`, `open_empty_tuples`, `vertically_align_attributes`, `vertically_align_object_elements`
+
+## CLI
+
+Console scripts defined in `pyproject.toml`. Each uses argparse flags that map directly to the option dataclass fields above.
+
+```
+hcl2tojson --json-indent 2 --with-meta file.tf
+jsontohcl2 --indent 4 --no-align file.json
+```
+
+Add new options as `parser.add_argument()` calls in the relevant entry point module.
+
+## PostLexer (`postlexer.py`)
+
+Lark's `postlex` parameter accepts a single object with a `process(stream)` method that transforms the token stream between the lexer and LALR parser. The `PostLexer` class is designed for extensibility: each transformation is a private method that accepts and yields tokens, and `process()` chains them together.
+
+Current passes:
+
+- `_merge_newlines_into_operators`
+
+To add a new pass: create a private method with the same `(self, stream) -> generator` signature, and add a `yield from` call in `process()`.
+
+## Hard Rules
+
+These are project-specific constraints that must not be violated:
+
+1. **Always use the LarkElement IR.** Never transform directly from Lark parse tree to Python dict or vice versa.
+1. **Block vs object distinction.** Use `__is_block__` markers (`const.IS_BLOCK`) to preserve semantic intent during round-trips. The deserializer must distinguish blocks from regular objects.
+1. **Bidirectional completeness.** Every serialization path must have a corresponding deserialization path. Test round-trip integrity: Parse → Serialize → Deserialize → Serialize produces identical results.
+1. **One grammar rule = one `LarkRule` class.** Each class implements `lark_name()`, typed property accessors, `serialize()`, and declares `_children_layout: Tuple[...]` (annotation only, no assignment) to document child structure.
+1. **Token caching.** Use the `StringToken` factory in `rules/tokens.py` — never create token instances directly.
+1. **Interpolation context.** `${...}` generation depends on nesting depth — always pass and respect `SerializationContext`.
+1. **Update both directions.** When adding language features, update transformer.py, deserializer.py, formatter.py and reconstructor.py.
+
+## Adding a New Language Construct
+
+1. Add grammar rules to `hcl2.lark`
+1. If the new construct creates LALR ambiguities with `NL_OR_COMMENT`, add a postlexer pass in `postlexer.py`
+1. Create rule class(es) in the appropriate `rules/` file
+1. Add transformer method(s) in `transformer.py`
+1. Implement `serialize()` in the rule class
+1. Update `deserializer.py`, `formatter.py` and `reconstructor.py` for round-trip support
+
+## Testing
+
+Framework: `unittest.TestCase` (not pytest).
+
+```
+python -m unittest discover -s test -p "test_*.py" -v
+```
+
+**Unit tests** (`test/unit/`): instantiate rule objects directly (no parsing).
+
+- `rules/` — one file per rules module
+- `cli/` — one file per CLI module
+- `test_*.py` — tests for corresponding files from `hcl2/` directory
+
+Use concrete stubs when testing ABCs (e.g., `StubExpression(ExpressionRule)`).
+
+**Integration tests** (`test/integration/`): full-pipeline tests with golden files.
+
+- `test_round_trip.py` — iterates over all suites in `hcl2_original/`, tests HCL→JSON, JSON→JSON, JSON→HCL, and full round-trip
+- `test_specialized.py` — feature-specific tests with golden files in `specialized/`
+
+Always run round-trip full test suite after any modification.
+
+## Pre-commit Checks
+
+Hooks are defined in `.pre-commit-config.yaml` (includes black, mypy, pylint, and others). All changed files must pass these checks before committing. When writing or modifying code:
+
+- Format Python with **black** (Python 3.8 target).
+- Ensure **mypy** and **pylint** pass. Pylint config is in `pylintrc`, scoped to `hcl2/` and `test/`.
+- End files with a newline; strip trailing whitespace (except under `test/integration/(hcl2_reconstructed|specialized)/`).
+
+## Keeping Docs Current
+
+Update this file when architecture, modules, API surface, or testing conventions change. Also update `README.md` and `docs/usage.md` when changes affect the public API, CLI flags, or option fields.

{python_hcl2-7.3.1 → python_hcl2-8.0.0rc2}/PKG-INFO

@@ -1,25 +1,24 @@
 Metadata-Version: 2.4
 Name: python-hcl2
-Version: 7.3.1
+Version: 8.0.0rc2
 Summary: A parser for HCL2
 Author-email: Amplify Education <github@amplify.com>
 License: MIT
 Project-URL: Homepage, https://github.com/amplify-education/python-hcl2
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.7.0
+Requires-Python: >=3.8.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: lark<2.0,>=1.1.5
@@ -27,7 +26,6 @@ Requires-Dist: regex>=2024.4.16
 Dynamic: license-file
 
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/2e2015f9297346cbaa788c46ab957827)](https://app.codacy.com/gh/amplify-education/python-hcl2/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
-[![Build Status](https://travis-ci.org/amplify-education/python-hcl2.svg?branch=master)](https://travis-ci.org/amplify-education/python-hcl2)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/amplify-education/python-hcl2/master/LICENSE)
 [![PyPI](https://img.shields.io/pypi/v/python-hcl2.svg)](https://pypi.org/project/python-hcl2/)
 [![Python Versions](https://img.shields.io/pypi/pyversions/python-hcl2.svg)](https://pypi.python.org/pypi/python-hcl2)
@@ -52,7 +50,7 @@ Learn more at <https://www.amplify.com>
 
 ### Prerequisites
 
-python-hcl2 requires Python 3.7 or higher to run.
+python-hcl2 requires Python 3.8 or higher to run.
 
 ### Installing
 
@@ -64,19 +62,58 @@ pip3 install python-hcl2
 
 ### Usage
 
+**HCL2 to Python dict:**
+
 ```python
 import hcl2
-with open('foo.tf', 'r') as file:
-    dict = hcl2.load(file)
+
+with open("main.tf") as f:
+    data = hcl2.load(f)
 ```
 
-### Parse Tree to HCL2 reconstruction
+**Python dict to HCL2:**
+
+```python
+import hcl2
+
+hcl_string = hcl2.dumps(data)
+
+with open("output.tf", "w") as f:
+    hcl2.dump(data, f)
+```
 
-With version 6.x the possibility of HCL2 reconstruction from the Lark Parse Tree and Python dictionaries directly was introduced.
+**Building HCL from scratch:**
 
-Documentation and an example of manipulating Lark Parse Tree and reconstructing it back into valid HCL2 can be found in [tree-to-hcl2-reconstruction.md](https://github.com/amplify-education/python-hcl2/blob/main/tree-to-hcl2-reconstruction.md) file.
+```python
+import hcl2
+
+doc = hcl2.Builder()
+res = doc.block("resource", labels=["aws_instance", "web"], ami="abc-123", instance_type="t2.micro")
+res.block("tags", Name="HelloWorld")
+
+hcl_string = hcl2.dumps(doc.build())
+```
+
+For the full API reference, option dataclasses, intermediate pipeline stages, and more examples
+see [docs/usage.md](https://github.com/amplify-education/python-hcl2/blob/main/docs/usage.md).
+
+### CLI Tools
+
+python-hcl2 ships two command-line converters:
+
+```sh
+# HCL2 → JSON
+hcl2tojson main.tf                     # prints JSON to stdout
+hcl2tojson main.tf output.json         # writes to file
+hcl2tojson terraform/ output/          # converts a directory
+
+# JSON → HCL2
+jsontohcl2 output.json                 # prints HCL2 to stdout
+jsontohcl2 output.json main.tf         # writes to file
+jsontohcl2 output/ terraform/          # converts a directory
+```
 
-More details about reconstruction implementation can be found in PRs #169 and #177.
+Both commands accept `-` as PATH to read from stdin. Run `hcl2tojson --help` or `jsontohcl2 --help` for the full list of flags.
 
 ## Building From Source
 
@@ -89,7 +126,7 @@ Running `tox` will automatically execute linters as well as the unit tests.
 
 You can also run them individually with the `-e` argument.
 
-For example, `tox -e py37-unit` will run the unit tests for python 3.7
+For example, `tox -e py310-unit` will run the unit tests for python 3.10
 
 To see all the available options, run `tox -l`.
 
@@ -109,21 +146,10 @@ You can reach us at <mailto:github@amplify.com>
 We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you:
 
 - For any sizable change, first open a GitHub issue to discuss your idea.
-- Create a pull request.  Explain why you want to make the change and what it’s for.
+- Create a pull request. Explain why you want to make the change and what it's for.
 
-We’ll try to answer any PR’s promptly.
+We'll try to answer any PR's promptly.
 
 ## Limitations
 
-### Using inline expression as an object key
-
-- Object key can be an expression as long as it is wrapped in parentheses:
-  ```terraform
-  locals {
-    foo = "bar"
-    baz = {
-      (format("key_prefix_%s", local.foo)) : "value"
-      # format("key_prefix_%s", local.foo) : "value" this will fail
-    }
-  }
-  ```
+None that are known.

{python_hcl2-7.3.1 → python_hcl2-8.0.0rc2}/README.md

@@ -1,5 +1,4 @@
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/2e2015f9297346cbaa788c46ab957827)](https://app.codacy.com/gh/amplify-education/python-hcl2/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
-[![Build Status](https://travis-ci.org/amplify-education/python-hcl2.svg?branch=master)](https://travis-ci.org/amplify-education/python-hcl2)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/amplify-education/python-hcl2/master/LICENSE)
 [![PyPI](https://img.shields.io/pypi/v/python-hcl2.svg)](https://pypi.org/project/python-hcl2/)
 [![Python Versions](https://img.shields.io/pypi/pyversions/python-hcl2.svg)](https://pypi.python.org/pypi/python-hcl2)
@@ -24,7 +23,7 @@ Learn more at <https://www.amplify.com>
 
 ### Prerequisites
 
-python-hcl2 requires Python 3.7 or higher to run.
+python-hcl2 requires Python 3.8 or higher to run.
 
 ### Installing
 
@@ -36,19 +35,58 @@ pip3 install python-hcl2
 
 ### Usage
 
+**HCL2 to Python dict:**
+
 ```python
 import hcl2
-with open('foo.tf', 'r') as file:
-    dict = hcl2.load(file)
+
+with open("main.tf") as f:
+    data = hcl2.load(f)
 ```
 
-### Parse Tree to HCL2 reconstruction
+**Python dict to HCL2:**
+
+```python
+import hcl2
+
+hcl_string = hcl2.dumps(data)
+
+with open("output.tf", "w") as f:
+    hcl2.dump(data, f)
+```
 
-With version 6.x the possibility of HCL2 reconstruction from the Lark Parse Tree and Python dictionaries directly was introduced.
+**Building HCL from scratch:**
 
-Documentation and an example of manipulating Lark Parse Tree and reconstructing it back into valid HCL2 can be found in [tree-to-hcl2-reconstruction.md](https://github.com/amplify-education/python-hcl2/blob/main/tree-to-hcl2-reconstruction.md) file.
+```python
+import hcl2
+
+doc = hcl2.Builder()
+res = doc.block("resource", labels=["aws_instance", "web"], ami="abc-123", instance_type="t2.micro")
+res.block("tags", Name="HelloWorld")
+
+hcl_string = hcl2.dumps(doc.build())
+```
+
+For the full API reference, option dataclasses, intermediate pipeline stages, and more examples
+see [docs/usage.md](https://github.com/amplify-education/python-hcl2/blob/main/docs/usage.md).
+
+### CLI Tools
+
+python-hcl2 ships two command-line converters:
+
+```sh
+# HCL2 → JSON
+hcl2tojson main.tf                     # prints JSON to stdout
+hcl2tojson main.tf output.json         # writes to file
+hcl2tojson terraform/ output/          # converts a directory
+
+# JSON → HCL2
+jsontohcl2 output.json                 # prints HCL2 to stdout
+jsontohcl2 output.json main.tf         # writes to file
+jsontohcl2 output/ terraform/          # converts a directory
+```
 
-More details about reconstruction implementation can be found in PRs #169 and #177.
+Both commands accept `-` as PATH to read from stdin. Run `hcl2tojson --help` or `jsontohcl2 --help` for the full list of flags.
 
 ## Building From Source
 
@@ -61,7 +99,7 @@ Running `tox` will automatically execute linters as well as the unit tests.
 
 You can also run them individually with the `-e` argument.
 
-For example, `tox -e py37-unit` will run the unit tests for python 3.7
+For example, `tox -e py310-unit` will run the unit tests for python 3.10
 
 To see all the available options, run `tox -l`.
 
@@ -81,21 +119,10 @@ You can reach us at <mailto:github@amplify.com>
 We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you:
 
 - For any sizable change, first open a GitHub issue to discuss your idea.
-- Create a pull request.  Explain why you want to make the change and what it’s for.
+- Create a pull request. Explain why you want to make the change and what it's for.
 
-We’ll try to answer any PR’s promptly.
+We'll try to answer any PR's promptly.
 
 ## Limitations
 
-### Using inline expression as an object key
-
-- Object key can be an expression as long as it is wrapped in parentheses:
-  ```terraform
-  locals {
-    foo = "bar"
-    baz = {
-      (format("key_prefix_%s", local.foo)) : "value"
-      # format("key_prefix_%s", local.foo) : "value" this will fail
-    }
-  }
-  ```
+None that are known.