easycoder 5__tar.gz → 241211.1__tar.gz

easycoder-241211.1/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.3
+Name: easycoder
+Version: 241211.1
+Summary: EasyCoder for Python
+Author-email: Graham Trott <gtanyware@gmail.com>
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: MIT License
+Requires-Dist: pytz
+Project-URL: Home, https://github.com/easycoder
+
+# Introduction
+This is the Python version of **_EasyCoder_**, a high-level English-like scripting language suited for prototyping and rapid testing of ideas. It operates on the command line.
+
+The JavaScript version of **_EasyCoder_**, which provides a full set of graphical features to run in a browser, is at
+
+Repository: [https://github.com/easycoder/easycoder.github.io](https://github.com/easycoder/easycoder.github.io)
+Website: [https://easycoder.github.io](https://easycoder.github.io)
+
+## Quick Start
+Install **_EasyCoder_** in your Python environment:
+```
+pip install easycoder
+```
+Write a test script, 'hello.ecs', containing the following:
+```
+print `Hello, world!`
+```
+This is traditionally the first program to be written in virtually any language. To run it, use `easycoder hello.ecs`.
+
+The output will look like this:
+
+```
+EasyCoder version 5
+Compiled <anon>: 1 lines (2 tokens) in 0 ms
+Run <anon>
+1-> Hello, world!
+```
+It's conventional to add a program title to a script:
+
+```
+!   Test script
+    script Test
+    print `Hello, world!`
+```
+The first line here is just a comment and has no effect on the running of the script. The second line gives the script a name, which is useful in debugging as it says which script was running. When run, the output is now
+
+```
+EasyCoder version 5
+Compiled Test: 5 lines (4 tokens) in 0 ms
+Run Test
+5-> Hello, world!
+```
+As you can guess from the above, the print command gives the line in the script it was called from. This is very useful in tracking down debugging print commands in large scripts.
+
+Here in the repository is a folder called `scripts` containing some sample scripts:
+
+`benchmark.ecs` allows the performance of EasyCoder to be compared to other languages if a similar program is written for each one  
+`tests.ecs` is a test program containing many of the EasyCoder features  
+`fizzbuzz.ecs` is a simple programming challenge often given at job interviews
+
+## The EasyCoder programming language
+There are three primary components to the language:
+
+ - Keywords
+ - Values
+ - Conditions
+
+The language comprises a general-purpose core package, which can be enhanced by plugins to provide special features on demand.
+
+[The core package](doc/core.md)
+

easycoder-241211.1/README.md

@@ -0,0 +1,60 @@
+# Introduction
+This is the Python version of **_EasyCoder_**, a high-level English-like scripting language suited for prototyping and rapid testing of ideas. It operates on the command line.
+
+The JavaScript version of **_EasyCoder_**, which provides a full set of graphical features to run in a browser, is at
+
+Repository: [https://github.com/easycoder/easycoder.github.io](https://github.com/easycoder/easycoder.github.io)
+Website: [https://easycoder.github.io](https://easycoder.github.io)
+
+## Quick Start
+Install **_EasyCoder_** in your Python environment:
+```
+pip install easycoder
+```
+Write a test script, 'hello.ecs', containing the following:
+```
+print `Hello, world!`
+```
+This is traditionally the first program to be written in virtually any language. To run it, use `easycoder hello.ecs`.
+
+The output will look like this:
+
+```
+EasyCoder version 5
+Compiled <anon>: 1 lines (2 tokens) in 0 ms
+Run <anon>
+1-> Hello, world!
+```
+It's conventional to add a program title to a script:
+
+```
+!   Test script
+    script Test
+    print `Hello, world!`
+```
+The first line here is just a comment and has no effect on the running of the script. The second line gives the script a name, which is useful in debugging as it says which script was running. When run, the output is now
+
+```
+EasyCoder version 5
+Compiled Test: 5 lines (4 tokens) in 0 ms
+Run Test
+5-> Hello, world!
+```
+As you can guess from the above, the print command gives the line in the script it was called from. This is very useful in tracking down debugging print commands in large scripts.
+
+Here in the repository is a folder called `scripts` containing some sample scripts:
+
+`benchmark.ecs` allows the performance of EasyCoder to be compared to other languages if a similar program is written for each one  
+`tests.ecs` is a test program containing many of the EasyCoder features  
+`fizzbuzz.ecs` is a simple programming challenge often given at job interviews
+
+## The EasyCoder programming language
+There are three primary components to the language:
+
+ - Keywords
+ - Values
+ - Conditions
+
+The language comprises a general-purpose core package, which can be enhanced by plugins to provide special features on demand.
+
+[The core package](doc/core.md)

easycoder-241211.1/doc/core/add.md

@@ -0,0 +1,13 @@
+## Syntax:
+`add {value} to {variable}`  
+`add {value} to {value} giving {variable}`
+## Examples:
+`add 1 to N`  
+`add N to Count giving Total`
+## Description:
+Adds a numeric value to a numeric variable or adds two values and puts the result into a variable. See elsewhere in this documentation for an explanation of what is meant by a value. If you add to a variable it must already hold a numeric value, and if you assign a variable to hold the result of an addition it will lose whatever value it previously held. 
+
+Next: [append](append.md)  
+Prev: [write](write.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/append.md

@@ -0,0 +1,13 @@
+## Syntax:
+`append {value} to {array}`
+## Examples:
+`put empty into ItemArray`  
+`append `First value` to ItemArray`  
+`append `Second value` to ItemArray`
+## Description:
+Appends an item to a JSON array, which is is a string value held in a single variable element (not to be confused with a multi-element variable). See also [element](element.md).
+
+Next: [assert](assert.md)  
+Prev: [add](add.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/assert.md

@@ -0,0 +1,11 @@
+## Syntax:
+`assert {condition}`
+## Examples:
+`assert Value is 5`
+## Description:
+Tests the condition and throws an exception if it is not true.
+
+Next: [begin](begin.md)  
+Prev: [append](append.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/begin.md

@@ -0,0 +1,15 @@
+## Syntax:
+`begin ... end`
+## Examples:
+`if Flag`  
+`begin`  
+`  add 1 to Counter`  
+`  set Repeat`  
+`end`
+## Description:
+`begin` introduces a compound statement; a block of commands that start with `begin` and finish with `end`. The entire block is treated as a single statement and `end` marks the end of the compound statement block.
+
+Next: [clear](clear.md)  
+Prev: [assert](assert.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/clear.md

@@ -0,0 +1,13 @@
+## Syntax:
+`clear {variable}`
+
+## Examples:
+`clear Flag`
+
+## Description:
+`clear` sets the value of the [variable](variable.md) to the Boolean value `false`. See also [set](set.md).
+
+Next: [close](close.md)  
+Prev: [begin](begin.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/close.md

@@ -0,0 +1,11 @@
+## Syntax:
+`close {file}`
+## Examples:
+`close InputFile`
+## Description:
+Close the file identified by the `{file}` variable. See `file`, `open`, `read` and `write`. 
+
+Next: [create](create.md)  
+Prev: [clear](clear.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/create.md

@@ -0,0 +1,11 @@
+## Syntax:
+`create directory {name}`
+## Examples:
+`create directory Items`
+## Description:
+Create a directory, giving the full path in `{name}`. 
+
+Next: [debug](debug.md)  
+Prev: [close](close.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/debug.md

@@ -0,0 +1,16 @@
+## Syntax:
+`debug step/stop/program`
+## Examples:
+`debug step`  
+`debug stop`  
+`debug program`
+## Description:
+Set up a debug option.  
+`debug step` causes the runtime to display each line before it executes it  
+`debug stop` cancels `debug step`  
+`debug program` displays the entire program
+
+Next: [decrement](decrement.md)  
+Prev: [create](create.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/decrement.md

@@ -0,0 +1,11 @@
+## Syntax:
+`decrement {variable}`
+## Examples:
+`decrement N`
+## Description:
+Decrements the value of the variable by 1. See also [increment](increment.md)
+
+Next: [delete](delete.md)  
+Prev: [debug](debug.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/delete.md

@@ -0,0 +1,16 @@
+## Syntax:
+`delete {filename}`  
+`delete property {value} of {variable}`
+
+## Examples:
+`delete file {filename}`  
+``delete property `name` of Record``
+
+## Description:
+The first form deletes the file whose full or relative path is given.  
+The second form deletes a named property of an object. See also [set property](set.md).
+
+Next: [divide](divide.md)  
+Prev: [decrement](decrement.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/divide.md

@@ -0,0 +1,14 @@
+## Syntax:
+`divide {value} by {variable}`  
+`divide {value} by {value} giving {variable}`
+## Examples:
+`divide Count by 2`  
+`divide Count by N`  
+`divide Count by N giving Total`
+## Description:
+Divides a numeric variable by a numeric value or divides one value by another and puts the result into a variable. See elsewhere in this documentation for an explanation of what is meant by a value. If you divide a variable it must already hold a numeric value, and if you assign a variable to hold the result of a division it will lose whatever value it previously held. 
+
+Next: [exit](exit.md)  
+Prev: [delete](delete.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/exit.md

@@ -0,0 +1,11 @@
+## Syntax:
+`exit`
+## Examples:
+`exit`
+## Description:
+Terminate the program.
+
+Next: [file](file.md)  
+Prev: [divide](divide.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/file.md

@@ -0,0 +1,14 @@
+## Syntax:
+`file {name}`
+## Example:
+`file InputFile`  
+``open InputFile `mydata.txt` for reading``  
+`read Data from InputFile`  
+`close InputFile`
+## Description:
+Declare a file variable. See [open](open.md), [read](read.md), [write](write.md) and [close](close.md).
+
+Next: [fork](fork.md)  
+Prev: [exit](exit.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/fork.md

@@ -0,0 +1,13 @@
+## Syntax:
+`fork to {label}`
+## Examples:
+`fork to RunBackgroundTask`
+## Description:
+`fork` is a special kind of [goto](goto.md), that causes the program to execute from the given label but also continue executing at the next command. The multitasking implied in this is handled by EasyCoder. Python programmers will know that the language is single threaded, so a cooperative technique is used internally to create the illusion of true multitasking.
+
+When `fork` is used, the forked commands run until they reach a [stop](stop.md) or [wait](wait.md), then execution resumes at the command following the `fork`. If your forked commands comprise a loop, be sure to put in a short delay ([wait](wait.md)) to allow other 'processes' to get some CPU time.
+
+Next: [get](get.md)  
+Prev: [exit](exit.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/get.md

@@ -0,0 +1,15 @@
+## Syntax:
+`get {variable from {url} [or {command}]}`
+
+## Examples:
+`get Content from Path`  
+``get Content from `https://myserver.com/testdata.txt` ``  
+``get Content from `https://myserver.com/testdata.txt` or goto AbandonShip``
+
+## Description:
+Perform an HTTP GET to request data. In the second example, if the request fails some appropriate action can be taken.
+
+Next: [gosub](gosub.md)  
+Prev: [fork](fork.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/go.md

@@ -0,0 +1,13 @@
+## Syntax:
+`go [to] {label}`  
+`goto {label}`
+## Examples:
+`go to Step5`  
+`goto Step5`
+## Description:
+`gosub` is like go in that it transfers control to the named label. However, when the program encounters a `return` command, execution resumes at the command following the `gosub`.
+
+Next: [gosub](gosub.md)  
+Prev: [get](get.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/gosub.md

@@ -0,0 +1,12 @@
+## Syntax:
+`gosub [to] {label}`
+## Examples:
+`gosub CheckValues`  
+`gosub to CheckValues`
+## Description:
+`gosub` is like `go` in that it transfers control to the named label. However, when the program encounters a `return` command, execution resumes at the command following the `gosub`.
+
+Next: [if](if.md)  
+Prev: [go](go.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/if.md

@@ -0,0 +1,14 @@
+## Syntax:
+`if {condition} {true-outcome} [else {false-outcome}]`
+
+## Examples:
+`if Value1 is greater than Value2 put true into Result`  
+``if Remaining is 0 print 'Finished` else add Remaining to ItemCount``
+
+## Description:
+`if` tests the condition that follows. If the result is `true` then control resumes at the named label; otherwise if there's an `else` section this is executed, then the program resumes at the next instruction after the `if`. See also [while](while.md).
+
+Next: [increment](increment.md)  
+Prev: [gosub](gosub.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/increment.md

@@ -0,0 +1,13 @@
+## Syntax:
+`increment {variable}`
+
+## Examples:
+`increment N`
+
+## Description:
+Add 1 to the value of the variable. See also [decrement](decrement.md).
+
+Next: [index](index.md)  
+Prev: [if](if.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/index.md

@@ -0,0 +1,15 @@
+## Syntax:
+`index {variable} to {value}`
+
+## Examples:
+`set the elements of List to 10`  
+`index List to 5`  
+`put Result into List`
+
+## Description:
+`index` is a special command for array handling. In EasyCoder, all variables are arrays. Initially they only have one element but you can [set](set.md) an array to have as many elements as you like, using `set the elements of {variable} to {value}`. Inside each array is the current index for the array, which you can set to any value within the number of elements in the array. The array is still used as if it were a simple variable and only the element pointed to by the index is affected by whatever you do with the array. Where multitasking is used - with [fork](fork.md) or by handling an event - you must be careful to set the index before using the array if there's any chance it may have been modified by another thread.
+
+Next: [init](init.md)  
+Prev: [increment](increment.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/init.md

@@ -0,0 +1,14 @@
+## Syntax:
+`init {stack}`
+
+## Examples:
+`stack ValueStack`  
+`init ValueStack`
+
+## Description:
+`init` initialises a [stack](stack.md) - an array object, so that values can be [push](push.md)ed to it and [pop](pop.md)ped from it. A [stack](stack.md) is a convenient place to store values during recursive operations.
+
+Next: [input](input.md)  
+Prev: [index](index.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/input.md

@@ -0,0 +1,13 @@
+## Syntax:
+`input {variable} [with {prompt}]`
+## Examples:
+`input MyName`  
+`input MyName with Prompt`  
+``input MyName with `Please type your name` ``
+## Description:
+`input` lets the user provide data from the keyboard, with an optional prompt string.
+
+Next: [multiply](multiply.md)  
+Prev: [init](init.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/multiply.md

@@ -0,0 +1,14 @@
+## Syntax:
+`multiply {value} by {variable}`  
+`multiply {value} by {value} giving {variable}`
+## Examples:
+`multiply Count by 2`  
+`multiply Count by N`  
+`divide Count by N giving Total`
+## Description:
+Multiplies a numeric variable by a numeric value or multiplies one value by another and puts the result into a variable. See elsewhere in this documentation for an explanation of what is meant by a value. If you multiply a variable it must already hold a numeric value, and if you assign a variable to hold the result of a multiplication it will lose whatever value it previously held. 
+
+Next: [open](open.md)  
+Prev: [input](input.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/open.md

@@ -0,0 +1,25 @@
+## Syntax:
+`open {file} {path} for reading/writing/appending`
+## Example:
+`file File1`  
+`file File2`  
+`file File3`
+
+``open File1 `oldvalues.txt` for reading``  
+``open File2 `newvalues.txt` for writing``  
+`read Value from File1`  
+`write Value to File2`  
+`close File2`  
+`close File1`
+
+``open File3 `somefile.txt` for appending``  
+``write `some data` to File3``  
+`close File3`
+
+## Description:
+Opens a disk file for reading, writing or appending. Each of the [file](file.md) variables must be declared as such as in the example.
+
+Next: [pop](pop.md)  
+Prev: [multiply](multiply.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/pop.md

@@ -0,0 +1,12 @@
+## Syntax:
+`pop {variable} from {stack}`
+## Examples:
+`pop SavedItem from DataStack`
+
+## Description:
+Pops the top value from the specified [stack](stack.md).
+
+Next: [post](post.md)  
+Prev: [open](open.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/post.md

@@ -0,0 +1,17 @@
+## Syntax:
+`post {value} to {url} [giving {variable}] [or {command}]`
+
+## Examples:
+``post MyData to `https://myserver.com/rest` ``  
+`post MyData to MyServer`  
+`post stringify Data to MyServer giving Result`  
+`` post `reset` to MyServer``  
+`post MyData to MyServer or go to AbandonShip`
+
+## Description:
+Perform an HTTP PUT request with the specified data and endpoint, optionally saving the value that returns and optionally trapping a failure.
+
+Next: [print](print.md)  
+Prev: [pop](pop.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/print.md

@@ -0,0 +1,14 @@
+## Syntax:
+`print {value}`
+## Examples:
+``print `Hello, world!` ``  
+`print Data cat newline`
+
+## Description:
+Print something to the terminal. The second example shows the use of string catenation, which is also covered in [values](../core.md).  
+The output is prefixed by the script line number of the print command. This is very useful in large scripts when trying to figure where print output is coming from.
+
+Next: [push](push.md)  
+Prev: [post](post.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/push.md

@@ -0,0 +1,13 @@
+## Syntax:
+`push {variable} to/onto {stack}`
+## Examples:
+``push `Hello, world!` to DataStack``  
+`push Value onto ValueStack`
+
+## Description:
+Push something onto the specified [stack](stack.md).
+
+Next: [put](put.md)  
+Prev: [print](print.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/put.md

@@ -0,0 +1,13 @@
+## Syntax:
+`put {value} into {variable}`
+## Examples:
+``put `Hello, world!` into Message``  
+`put Message cat newline into Message`
+
+## Description:
+Put a value into a [variable](variable.md). The second example illustrates how to append to a string.
+
+Next: [read](read.md)  
+Prev: [push](push.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/read.md

@@ -0,0 +1,12 @@
+## Syntax:
+`read {value} from {file}`
+## Examples:
+`read Value from MyFile`
+
+## Description:
+Read a value from a [file](file.md). See [open](open.md), [write](write.md) and [close](close.md).
+
+Next: [replace](replace.md)  
+Prev: [put](put.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/replace.md

@@ -0,0 +1,13 @@
+## Syntax:
+`replace {value} with {value} in {variable}`
+## Examples:
+``replace `one` with `two` in Sentence``  
+`replace Template with Value in Text`
+
+## Description:
+Replaces all occurrences of one string with another in a string [variable](variable.md).
+
+Next: [return](return.md)  
+Prev: [read](read.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/return.md

@@ -0,0 +1,12 @@
+## Syntax:
+`return`
+## Examples:
+`return`
+
+## Description:
+Return from a subroutine. See [gosub](gosub.md).
+
+Next: [script](script.md)  
+Prev: [replace](replace.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/script.md

@@ -0,0 +1,12 @@
+## Syntax:
+`script {name}`
+## Examples:
+`script Calculate`
+
+## Description:
+Provides a name for the script. Note that `name` is literal text, not a script variable.
+
+Next: [set](set.md)  
+Prev: [return](return.md)
+
+[Back](../core.md)

easycoder-241211.1/doc/core/set.md

@@ -0,0 +1,25 @@
+## Syntax:
+`set {variable}`  
+`set the elements of {variable} to {value}`  
+`set element/property {name} of {variable} to {value}`
+
+## Examples:
+`set Flag`  
+`set the elements of ThisVariable to 10`  
+`set element 5 of MyList to NewValue`  
+``set property `name` of MyProperties to `first` ``  
+``set property `age` of MyProperties to Age``
+
+## Description:
+`set` is a heavily used command in **_EasyCoder_**. Here in the core package it does the following, as listed in the Syntax above:
+
+-- assigns the boolean true value to the named [variable](variable.md). See also [clear](clear.md) and [toggle](toggle.md).
+
+-- assigns a specified number of elements to a variable - see [index](index.md). When used to change the size of an array the command preserves all elements that are not affected by the size change.
+
+-- Sets an element or a property of a [variable](variable.md), providing it was intialised appropriately. Elements can be added to a variable that is intialised as JSON list, for example as ``put json `[]` into MyList``. Properties can be set on a variable that is initialised as a JSON object, for example as ``put json `{}` into MyProperties``. Note that this has nothing to do with the indexing of variables using [index](index.md). Each of the elements of such a variable can be treated as either a JSON list or as a JSON object, and either can be used for different elements of the same variable.
+
+Next: [split](split.md)  
+Prev: [script](script.md)
+
+[Back](../core.md)