Skip to main content

Python utility to change indentations of files.

Project description

indentpy

Python script to change indentations of files.

Dependencies

This package requires the following programs to be installed:

  1. Python

Installation

The installation can be done by cloning this Github repository and running the ./install.sh script.

Cloning the Github repository:

git clone https://github.com/Thijsvanede/indentpy.git

Installing the script:

chmod +x ./install.sh
./install.sh

Usage

The python script can be used in several ways:

  1. As a command line program after installation.
  2. As a command line program from source.
  3. As a python library.

For all use cases we give a usage example.

Inputting special characters

When you wish to specify special characters like \t or \n, these can be put into a bash terminal by the combination ctrl+v followed by the key for that character. Examples:

  • \t: ctrl+v followed by tab
  • \n: ctrl+v followed by enter
  • \r\n: ctrl+v followed by crtl+r followed by ctrl+v followed by enter

Command-line (Installed)

The usage of indent is explained in the help file below.

Usage: indent [-h] [-w WRITE] [-o ORIG] [-t TO] [-d DELIM] file [file ...]

Change indentation of file(s).

positional arguments:
    file    File(s) for which to change indentation.

optional arguments:
    -h    Show this help text.
    -d    Line delimiter in original file    (optional, default='\n').
    -o    Indentation style in original file (optional, default='\t').
    -t    Indentation style in desired  file (optional, default='    ').
    -w    File to write output to (optional, default writes to inputfile).

Example

The following example takes infile.py, transforms the original \t indentation to 4 spaces and finally writes it to outfile.py.

indent -w outfile.py -o '	' -t '    ', infile.py

Command-line (From source)

To run the program from source, you can use both Python 2 and Python 3. The usage of indent/indent.py is explained in the help file below.

usage: indent.py [-h] [-w WRITE] [-o ORIG] [-t TO] [-d DELIM] file [file ...]

Indentation change tool.

positional arguments:
  file                      File(s) for which to change indentation.

optional arguments:
  -h, --help                show this help message and exit
  -w WRITE, --write WRITE   File to write output to (optional, if none is given,
                            change contents of file.
  -o ORIG, --orig ORIG      Indentation style in original file (optional, if none
                            is given, use '\t').
  -t TO, --to TO            Indentation style in desired file (optional, if none
                            is given, use 4 spaces).
  -d DELIM, --delim DELIM   Line delimiter in original file (optional, if none is
                            given, use '\n')

Example

The following example takes infile.py, transforms the original \t indentation to 4 spaces and finally writes it to outfile.py.

python indent/indent.py -w outfile.py -o '	' -t '    ', infile.py

Python

TODO

Project details


Release history Release notifications

Download files

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

Files for indentpy, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size indentpy-1.0.0-py3-none-any.whl (3.8 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size indentpy-1.0.0.tar.gz (3.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page