Skip to main content

Creating file tree from text tree and vice versa

Project description

NAME

txdir — text tree from or to file tree

SYNOPSIS

txdir [<infile>|<indir>|-] [<outdir>|-] [<options>]

Options:

-h: help
-v: version
-l: flat listing
-f: exclude files
-d: include dot files/directories
-n: exclude file content (don't reapply such a tree as it will empty all files)
-m: maximum depth
-c: commands to create directories (from https://github.com/gcmt/mktree)

Files/dirs are ignored via .gitignore.

Command line help:

usage: txdir [infile] [outdir] [-h] [-v] [-l] [-f] [-d] [-n] [-m M] [-c [C [C ...]]]

Files/dirs are ignored via .gitignore. If the directory contains unignored
binary files, exclude files with '-f'. Ignoring content with '-n', then
reapplying will empty all files. NOTE: EMPTY FILES IN TEXT TREE WILL EMPTY
ACCORDING FILES IN THE FILE TREE.

positional arguments:
  infile          If a file, it is expected to contain a text tree, flat or
                  indented (none or - is stdin). If a directory, the text tree
                  is created from the file tree (like the Linux tree tool).
  outdir          None or - means printing the tree to stdout. If the
                  parameter is an existing file, nothing is done. If not a
                  directory, the directory is created. The file tree is
                  created in the directory.

optional arguments:
  -h              Print help information.
  -v              Print version information.
  -l              Create a flat listing instead of an indented text tree from
                  file tree.
  -f              Omit files. Just directories, when creating a text tree from
                  a file tree.
  -d              Include dot files/directories when creating a text tree from
                  a file tree.
  -n              Omit file content when creating a text tree from a file
                  tree.
  -m M            Maximum depth to scan when creating a text tree from a file
                  tree.
  -c [C [C ...]]  Directories described with a DSL (',' = end of token, '.' =
                  up dir, '/' = down) `txdir - . -c a/b,c/d..a/u,v/g.x,g\.x`
                  produces the same as `mkdir -p a/{b,c}/d a/{u,v} a/x a/g.x`

DESCRIPTION

  • Construct a file tree from a text tree.

  • Construct a text tree from a file tree.

This allows to edit a whole file tree within one file first, without the necessity to switch files.

The text tree can also be templated and first run through a tool like stpl before being processed by M to produce the final file tree.

To install for user only, do:

pip install --user txdir

USAGE

Without arguments it expects input from stdin:

txdir

Exit this via CTRL+C. Use no input argument in combination piping, or when using -c.

Use on a directory tree where

  • binary text files are only in dotted directories (e.g. .git) or

  • binary files are ignored via .gitignore

txdir .

It produces text output to stdout, similar to tree, but with content, unless content is suppressed with -n.

You can save the output in a file and edit it:

txdir -l . > thisdir.txt

The -l option makes the output flat to distinguish what is content and what is tree. Don’t worry, you can also drop the -l, as txdir . | txdir - . does not create the same tree below thisdir.txt, because thisdir.txt exists as file and not as directory.

No directory is created unless a root directory is provided as second argument:

txdir thisdir.txt .

This applies the (edited) text tree in thisdir.txt on the current directory.

txdir . again

This produces the same tree below again, almost like a cp -R . again. But internally a text tree of the file tree is created and then applied to the new location.

txdir does not work for binary files. If there are binary files, use -f to exclude files. Ignoring content with ‘-n’, then reapplying will empty all files.

NOTE: EMPTY FILES IN TEXT TREE WILL EMPTY ACCORDING FILES IN THE FILE TREE.

Note, also, that text file content must not have an empty first line.

License

MIT

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

txdir-1.0.2-py3-none-any.whl (13.3 kB view hashes)

Uploaded py3

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