Skip to content
This repository has been archived by the owner on Jun 13, 2024. It is now read-only.

Latest commit

 

History

History
143 lines (96 loc) · 4.88 KB

README.md

File metadata and controls

143 lines (96 loc) · 4.88 KB
Raw

Termicoder

Build Status PyPI PyPI PyPI Requirements Status Licence image

View, Code, Submit directly from terminal
Made with ❤️ by Divesh Uttamchandani

A python based command line interface for helping in competitive programming. Termicoder aims at automating and simplifying the process of coding, testing and submitting solutions to Online Judges so that one can concentrate only on algorithms

Inspiration behind Termicoder

Installation

Requirements:

Python3.5+

Note: Termicoder is in its development stage and has only been tested on Ubuntu + python3.5.2. Support for other configurations is being worked on. If you are using some other platform and encounter errors, do create an issue about them. For windows one can also try using Bash on Ubuntu on Windows

User installation

pip3 install termicoder
pip with sudo if you get a permission error.

Developer installation

  • clone this repo

  • in the root folder of this repo run

    • pip3 install --editable .

  • to remove this package, in the root folder of the repo run

    • python setup.py develop --uninstall

Autocomplete for bash

To setup tab autocompletion for termicoder commands, see termicoder config autocomplete --help

Current Support

Judges Included

  1. CodeChef

Language Support

  1. C
  2. C++
  3. Python3

Though it is very easy to configure termicoder to work with other languages.

Highlights

Usage: termicoder [OPTIONS] COMMAND [ARGS]...

  __       __                      _                __
  \ \     / /____  _________ ___  (_)________  ____/ /__  _____
   \ \   / __/ _ \/ ___/ __ `__ \/ / ___/ __ \/ __  / _ \/ ___/
   / /  / /_/  __/ /  / / / / / / / /__/ /_/ / /_/ /  __/ /
  /_/   \__/\___/_/  /_/ /_/ /_/_/\___/\____/\__,_/\___/_/

  view, code & submit problems directly from terminal.

Options:
  --version            Show the version and exit.
  -v, --verbosity LVL  Either CRITICAL, ERROR, WARNING, INFO or DEBUG
  -h, --help           Show this message and exit.

Commands:
  clip    Copies code from file to clipboard.
  code    Creates and opens file with template code.
  config  Configure settings, autocomplete etc.
  debug   Launches custom debug interface.
  list    List the contents of current folder.
  repl    Start an interactive shell.
  setup   Sets up problem, contests and login.
  submit  Submit a solution.
  test    Test code against the sample testcases.
  view    View contests and problems.

Detailed Command Help

For details of a particular command use:

termicoder --help
termicoder <COMMAND> --help

You can have a look at helptext which contains the output of all help commands.

Sample Run

For a sample we recommend going through sample run which contains the details

ChangeLog

ChangeLog and Older Releases are availible under Releases .

Contributing to Termicoder

Termicoder is mostly written in python. If you are looking towards contributing to the code base, you should begin with reading the following:

You can also contribute otherwise by

  • Improving the Documentation.

    • Most of the documentation lies in the documentation folder. To start fork this repo, change and create a pull request

  • reporting a bug or requesting a feature.

    • Please create an issue about the bug/feature.

  • Giving feedback about the work. (both praise and criticism are equally appreciated).

Special Thanks to Contributors:

LICENSE

MIT