Plette: Structured Pipfile and Pipfile.lock models.

Plette is an implementation to the Pipfile specification. It offers parsers and style-preserving emitters to both the Pipfile and Pipfile.lock formats, with optional validators to both files.

Quickstart

Plette is available on PyPI. You can install it with pip:

pip install plette

Now you can load a Pipfile from path like this:

>>> import plette
>>> with open('./Pipfile', encoding='utf-8') as f:
...     pipfile = plette.Pipfile.load(f)
...

And access contents inside the file:

>>> pipfile['scripts']['tests']
'pytest -v tests'

Loading from a lock file works similarly:

>>> with open('./Pipfile.lock', encoding='utf-8') as f:
...     lockfile = plette.Lockfile.load(f)
...
>>> lockfile.meta.sources[0].url
'https://pypi.org/simple'

Contents

• Loading and Saving Files
  • Loading a File into a Model
  • Writing a File from the Model
• Top-Level Sections
  • Sections as Properties
  • Key-Value Access
  • Missing Sections
• Working with Nested Structures
  • The Data View
  • Data View Collections
• Validating Data
  • Setting up Validation
  • Validating Data