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.tar.gz (18.3 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-py3-none-any.whl (24.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: treescript_builder-0.1.tar.gz
  • Upload date:
  • Size: 18.3 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.tar.gz
Algorithm Hash digest
SHA256 8a6b5595c5f827b6ac6fe9c7e10375beba0ec3f3d9f57d389097f3b117fb08e2
MD5 4664cd01ff16798ba10a22a5b9548a88
BLAKE2b-256 e9c6721693d1db58429b36bb1e83e3a631881e671076165ac84040793dbacce1

See more details on using hashes here.

Provenance

The following attestation bundles were made for treescript_builder-0.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-py3-none-any.whl.

File metadata

File hashes

Hashes for treescript_builder-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c1e6e78ac7fe96f1729776999c6ad096f6303783a2ecf468f2768bca74a57339
MD5 fb1f89d80825583944f46116002bbdf5
BLAKE2b-256 637ec1b1d7b3eb60d8f225965f3fb9ca2d3454cf7e831a8acc75a8f5f7ebb2c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for treescript_builder-0.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