Skip to main content

A parser for HCL2

Project description

Codacy Badge Codacy Badge Build Status License PyPI Python Versions Downloads

Python HCL2

A parser for HCL2 written in Python using Lark. This parser only supports HCL2 and isn't backwards compatible with HCL v1. It can be used to parse any HCL2 config file such as Terraform.

About Amplify

Amplify builds innovative and compelling digital educational products that empower teachers and students across the country. We have a long history as the leading innovator in K-12 education - and have been described as the best tech company in education and the best education company in tech. While others try to shrink the learning experience into
the technology, we use technology to expand what is possible in real classrooms with real students and teachers.

Learn more at https://www.amplify.com

Getting Started

Prerequisites

python-hcl2 requires Python 3.6.0 or higher to run.

Installing

This package can be installed using pip

pip3 install python-hcl2

Usage

import hcl2
with open('foo.tf', 'r') as file:
    dict = hcl2.load(file)

Building From Source

For development, tox>=2.9.1 is recommended.

Running Tests

python-hcl2 uses tox. You will need to install tox with pip install tox. 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

To see all the available options, run tox -l.

Responsible Disclosure

If you have any security issue to report, contact project maintainers privately. You can reach us at mailto:github@amplify.com

Contributing

We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you:

  1. For any sizable change, first open a GitHub issue to discuss your idea.
  2. 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bc-python-hcl2-0.3.42.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bc_python_hcl2-0.3.42-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file bc-python-hcl2-0.3.42.tar.gz.

File metadata

  • Download URL: bc-python-hcl2-0.3.42.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.13

File hashes

Hashes for bc-python-hcl2-0.3.42.tar.gz
Algorithm Hash digest
SHA256 b383b6c6835a7d81c5053a3190ace0279363407e0ce43ecf729b2688066a47ff
MD5 91bb0c24ea99b2205953250e725617bf
BLAKE2b-256 5a7588e3b41c1b6ac30d5e04be4d18304b574b121e1bdc4a0b0f3d49bda55136

See more details on using hashes here.

File details

Details for the file bc_python_hcl2-0.3.42-py3-none-any.whl.

File metadata

File hashes

Hashes for bc_python_hcl2-0.3.42-py3-none-any.whl
Algorithm Hash digest
SHA256 ab9e851013561f537015725a2cc787091611c7f31bb900a03bd4ffc5e280054b
MD5 c5ac906f1896f079adf16c6f45d76cd2
BLAKE2b-256 e6c65c5fac6c689ed87ca9056fcb135dab8d39f6ce15598f58dedf01499da326

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page