ByronEncinas/Algernon

A tool created to quickly convert between TXT, XML, JSON, ... on a CLI-GUI written on Python

Algernon is a CLI/GUI app to manipulate data in different formats

What this commit is implementing (this section is different in all commits)

(this format just for now) $ python alger.py [ARGS] [FLAGS] ...

- [x] When using Algernon the GUI.py file is called

- [x] We will make it so that 

> $ python alger.py non 

    +------------------+
    |                  |                    
    |    GUI Window    |
    |                  |
    +------------------+ 

> $ python alger.py 
      o_o
     (_^_) ( °)>   
           |   U
           (__ )    


displays in the terminal a message with those two little animals

Table of Contents

• Pip Installation
• Parser & Visuals
• Commands CLI Algernon
• Usage GUI Algernon

Pip (production)

Algernon will be planned to be released as a pip package.

pip install algernon

Parser & Visuals

Algernon will count with the functionality of visualization of ASCII, JSON, XML, TOML, YAML, CSV with graphic interfaces: diagrams, arrows and even datatables.

Example JSON

{
    "name": "Soup",
    "ingredients": [
        {
            "ingredientName": "Water",
            "requiredAmount": 1
        },
        {
            "ingredientName": "Potatoes",
            "requiredAmount": 4
        }
    ]
}

Example XML

<recipe>
    <name>Soup</name>
    <ingredients>
        <ingredient>
            <ingredientName>Water</ingredientName>
            <requiredAmount>1</requiredAmount>
        </ingredient>
        <ingredient>
            <ingredientName>Potatoes</ingredientName>
            <requiredAmount>4</requiredAmount>
        </ingredient>
    </ingredients>
</recipe>

Example YAML

name: Soup
ingredients:
  - ingredientName: Water
    requiredAmount: 1
  - ingredientName: Potatoes
    requiredAmount: 4

Example TOML

name = "Soup"

[[ingredients]]
ingredientName = "Water"
requiredAmount = 1

[[ingredients]]
ingredientName = "Potatoes"
requiredAmount = 4

Crystallographic convertion of data

Due to some interest in taking a more scientific use of this, we will add a set of instructions to convert from XYZ format to CIF. This feature remains pending.

Commands CLI Algernon

Usage GUI Algernon