Skip to main content

YamlStripper

YamlStripper is a Python command-line tool for removing specified fields from YAML files.

Installation

To use YamlStripper, you need to have Python 3 installed on your computer. You can download and install Python 3 from the official Python website: https://www.python.org/downloads/

After installing Python 3, you can install YamlStripper using pip, the Python package manager:

pip install yaml-stripper

Usage

To use YamlStripper, open a command prompt or terminal window and type the following command:

yaml-stripper input_file output_file -f field1 field2 ...

where:

  • input_file - The input YAML file to remove fields from.
  • output_file - The output YAML file without the specified fields.
  • -f field1 field2 ... - The fields to remove from the input YAML file.

For example, if you have a YAML file called example.yaml with the following contents:

name: John
age: 30
email: john@example.com
phone: 123-456-7890

and you want to remove the email and phone fields from this YAML file and save the result in a new file called stripped.yaml, you can use the following command:

yaml-stripper example.yaml stripped.yaml -f email phone

After running the command, a new file called stripped.yaml will be created with the following contents:

name: John
age: 30

Examples

Here are some more examples of how to use YamlStripper:

Example 1

Suppose you have a YAML file called data.yaml with the following contents:

name: Alice
age: 25
email: alice@example.com
phone: 987-654-3210
address:
  street: 123 Main St
  city: Anytown
  state: CA
  zip: 12345

You want to remove the email and phone fields from this YAML file and save the result in a new file called stripped.yaml. Here's how you can use YamlStripper to achieve this:

yaml-stripper data.yaml stripped.yaml -f email phone

After running the command, a new file called stripped.yaml will be created with the following contents:

name: Alice
age: 25
address:
  street: 123 Main St
  city: Anytown
  state: CA
  zip: 12345

Example 2

Suppose you have a YAML file called config.yaml with the following contents:

debug: true
port: 8000
database:
  host: localhost
  port: 5432
  name: mydb
  user: myuser
  password: mypass

You want to remove the debug field from this YAML file and save the result in a new file called stripped.yaml. Here's how you can use YamlStripper to achieve this:

yaml-stripper config.yaml stripped.yaml -f debug

After running the command, a new file called stripped.yaml will be created with the following contents:

port: 8000
database:
  host: localhost
  port: 5432
  name: mydb
  user: myuser
 

Metadata

Release files for yaml-stripper 2.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for yaml-stripper 2.1.2
File Size Uploaded
yaml-stripper-2.1.2.tar.gz 3.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for yaml-stripper 2.1.2
File Interpreter ABI Platform
yaml_stripper-2.1.2-py3-none-any.whl Python 3 none any Details

Total release size: 8.0 kB

Release files / yaml-stripper-2.1.2.tar.gz

Download URL yaml-stripper-2.1.2.tar.gz
Size 3.5 kB
Tags Source
SHA-256 checksum
How to use checksums
d9490100ca4e8366b3564e0a282e795585d2df4b887aeee26c60486bc5c9f28f
BLAKE2b-256 checksum
How to use checksums
ccd940f40ba90e3fd5a8ae5b8bf0e6b1c8ec100f6811cb49308a820a4fb99b4e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.16

Release files / yaml_stripper-2.1.2-py3-none-any.whl

Download URL yaml_stripper-2.1.2-py3-none-any.whl
Size 4.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c6b3409f6ecd6899f11ed5638073db575deed9ffb35c2c9d8eec465a9a7d3936
BLAKE2b-256 checksum
How to use checksums
dc04a041bb9f5269b5d6673b5c2818db06e14ed348751ac5171c1d5440f603d6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.16

Release history Release notifications | RSS feed

This release

2.1.2 This release

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

0.1.29

2 release files

0.1.28

2 release files

0.1.27

2 release files

0.1.26

2 release files

0.1.25

2 release files

0.1.24

2 release files

0.1.23

2 release files

0.1.22

2 release files

0.1.21

2 release files

0.1.20

2 release files

0.1.19

2 release files

0.1.18

2 release files

0.1.17

2 release files

0.1.16

2 release files

0.1.15

2 release files

0.1.14

2 release files

0.1.13

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page