Skip to main content

Builds File Trees from TreeScript. If DataLabels are present in TreeScript, a DataDirectory argument is required.

Project description

TreeScript FileTreeBuilder

Script for Building File Trees.

  • Makes your dreams come true.

How To

  1. Prepare Your TreeScript Designs.
    • Initial and Final TreeScripts.
    • Build New Project Package/Module.
  2. Logical Order of TreeScript Builder Operations.
  3. Run TreeScript Builder from the CommandLine.
    • Apply combinations of Operations to build TreeScript Workflows.

Project Technical Details:

File Tree Builder

Execute the File Tree Builder with the ftb command.

  • Creates Files and Directories
  • If DataLabels are present, a DataDirectory is required.

File Tree Trimmer (Remover)

Execute the File Tree Remover by adding the --trim argument.

  • Removes Files and Empty Directories.
  • DataLabels require DataDirectory.
    • Files are exported to the DataDirectory.

Default Input Reader

Before the Reader receives TreeScript, the input is filtered so comments and empty lines are not ever seen by the Reader. The Default Input Reader processes one line at a time and calculates multiple file tree node properties that it stores in dataclass objects.

It calculates for each node:

  • Name
  • File or directory status
  • Depth in tree
  • (optional) DataArgument

Builder Data Feature

The Builder provides one additional feature that goes beyond creation of the File Tree. This feature enables Files to be created with data inserted immediately.

Input Data Argument

The Data Argument specifies what will be inserted into the file that is created. The Data Argument is provided in the Input File, immediately after the File Name (separated by a space). There are two types of Data Arguments:

  • DataLabel
  • InlineContent

Builder DataLabel Feature

A DataLabel is a link to Text content to be inserted into the file.

  • DataLabel is present in both the DataDirectory, and the TreeScript File.

Tree Trim Data Directory Feature

The Remover provides an additional feature beyond the removal of files in the Tree. This feature enables Files to be saved to a Data Directory when they are removed. Rather than destroying the file data, it is moved to a new directory.

To-Do Features

Builder File Inline Content (TODO)

Inline Content is written in the Tree Node Structure Input file itself. To distinguish DataContent from a DataLabel, the Content must begin with a special character.

Options for the DataContent character are under consideration.

  • Less than bracket is a good option: <
  • Star char is an alternative: *

This feature is a neat mid-sized improvement that may open up opportunities for more workflow flexibility.

  • Adding a new file late in the process.
    • such as after data directory is already prepared, and you review TS and notice a little thing missing.
    • value-adding option that helps you build files faster, more convenient than the DataDirectory.
  • Workflows that use TreeScript.
    • Easier To Plan, and Communicate What You Did.
    • Package Restructuring, Migrations.
    • Test Environment Setup
    • FileSystem Inventory

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

treescript_builder-0.1.1.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

treescript_builder-0.1.1-py3-none-any.whl (24.7 kB view details)

Uploaded Python 3

File details

Details for the file treescript_builder-0.1.1.tar.gz.

File metadata

  • Download URL: treescript_builder-0.1.1.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for treescript_builder-0.1.1.tar.gz
Algorithm Hash digest
SHA256 40335ad8021d685adece4d232a74844eff17349df75feb3ac15786605d881892
MD5 af86b9ee52881f306ce0832810761481
BLAKE2b-256 fbed37fd52e2ceb6367ae9ecd6e06f3152433fc1d56c28d5c6f9e8449ecabc9f

See more details on using hashes here.

Provenance

The following attestation bundles were made for treescript_builder-0.1.1.tar.gz:

Publisher: publish.yml on DK96-OS/treescript-builder

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file treescript_builder-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for treescript_builder-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 292a44b10d554cff791e2649d94706fe36f5f73587b26ed151164ededfa1a8e1
MD5 2395c12bb4d49b71f30c32d6fb810bd9
BLAKE2b-256 ad46d70e4f1af503d3dec263eb1297f31b9a0324c70cf0c43c2df02a3e1545ae

See more details on using hashes here.

Provenance

The following attestation bundles were made for treescript_builder-0.1.1-py3-none-any.whl:

Publisher: publish.yml on DK96-OS/treescript-builder

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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