Skip to main content

A CLI tool to run code

Project description

edl-cr

A CLI tool to run code. See more at here

Project Status:

Repository
Dependencies
Build
Release
Package

Install

Use pip to install edl-cr.

pip install edl-cr

Usage

Use command ecr to run edl-cr.

CLI Mode

Option Description
-w --wdir Set working directory
-c --command Execute command just like in interactive mode

Interactive Mode

If you don't use --command options, edl-cr will run in interactive mode.

Initialize

> init

Initialize ECR data. It will create a directory named .ecr in current directory.

If you want to clear ECR data, use this command:

> clear

Create and Run

Create a new code file:

> new a.cpp

It will use code template in .ecr/templates/ to create file and set current file with the new file.

If you want to set current file with a existed file, use this:

> now a.cpp

Then use edit to open default editor to edit code:

> edit

Then use run command to run code.

# run a.cpp
a.cpp> run

# run b.cpp
a.cpp> run b.cpp

# run a.cpp with file input and standard output
a.cpp> run -io fs

Input and Output

The file input is at .ecr/input.data, and the file output is at .ecr/output.data.

Clean

Clean the compiling output and something else:

> clean

Variables

You can use builtin variables just like in bash:

echo $wdir
Variable Description
wdir Working directory
current Current file
input Input file
output Output file
config Config file

Commands

These are builtin commands. You can use system command in importedCommand list.

Command Description
init Initialize ECR data
clear Clear ECR data
new [file] [-e --edit] Create new code file
now [file] Change current file
edit [file] [-n --now] Edit code file
run [file] [-io --io] Run code file
clean Clean temp files
pwd Print working directory
cd Change working directory
version Get version
cls Clear console
exit Exit
-h --help Get help

Config

The config files is at .ecr/

config.json

This file contains basic config.

{
    // File extension name to be cleaned
    "tempFileFilter": [
        "exe",
        "o",
        "class",
        "out"
    ],

    // Map name to system command
    "importedCommand": {
        "ls": "ls",
        "cls": "clear"
    },

    // The default shell to execute command
    "defaultShell": "powershell -c",

    // The default IO when run
    "defaultIO": "ss",

    // The default time limit for every step when run
    "defaultTimeLimit": 5,

    // The default editor
    "defaultEditor": "vim"
}

executor.json

This file gives the way to run a code file.

You can use these varibles in command:

  • fileName The code file name
  • fileNameWithoutExt The code file name without extension
{
    "c": [
        "gcc {fileName} -o {fileNameWithoutExt}",
        "./{fileNameWithoutExt}"
    ],
    "cpp": [
        "g++ {fileName} -o {fileNameWithoutExt}",
        "./{fileNameWithoutExt}"
    ],
}

Developing

  • The Makefile use SHELL varible in Windows (as well as PY), so if you are in Linux, change it before use make.
  • To build and upload the package, this requires these modules setuptools, wheel, twine. You can try make prepare to install these modules.
# Run
make run

make run RARG=-h # use command args

# Test
make test

# Test and get coverage
make cover

# Build
make build -B

# Install locally
make install

# Uninstall locally
make uninstall

# Clean
make clean

# Upload to PyPI
make upload

# Upload to TestPyPI
make uptest

Requirements

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

edl-cr-0.0.1.5.tar.gz (14.1 kB view hashes)

Uploaded Source

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