Skip to main content

A parser for HCL2

Project description

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.7 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>=4.0.9 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.

Releasing

To create a new releaes go to Releases page, press 'Draft a new release', create a tag with a version you want to be released, fill the release notes and press 'Publish release'. Github actions will take care of publishing it to PyPi.

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:

  • 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.

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

python-hcl2-4.3.5.tar.gz (19.4 kB view details)

Uploaded Source

Built Distribution

python_hcl2-4.3.5-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file python-hcl2-4.3.5.tar.gz.

File metadata

  • Download URL: python-hcl2-4.3.5.tar.gz
  • Upload date:
  • Size: 19.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for python-hcl2-4.3.5.tar.gz
Algorithm Hash digest
SHA256 71fbe48ee9a13335828f04adff2b267e06045c44c99c737b13d940aa1468d101
MD5 9b641f86087120de741ed9b9d0e000cd
BLAKE2b-256 17b86d82f3ac6b14493e524df946365670235570a2074cb2621ea67caa4e8952

See more details on using hashes here.

File details

Details for the file python_hcl2-4.3.5-py3-none-any.whl.

File metadata

  • Download URL: python_hcl2-4.3.5-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for python_hcl2-4.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e33795eed675ae59545e725d1de0a8d78b4166b30b6e0bc7699365bd06334068
MD5 a5b9a96acfa5a88b53ac303d6f20dd76
BLAKE2b-256 ab5c9a1fb7ebbd9d070ae6a491e7051ac9b56f71c4c59f930fb42a8ef6c7f832

See more details on using hashes here.

Supported by

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