Run context-aware commands from your source code comments

Last update: Nov 09, 2021

Related tags

Overview

Run context-aware commands from your source code comments.

Codeline allows you to run custom commands directly from source-code comments, combining the power of IDE extensions with the expressiveness of the command-line.

Current State

Codeline is functional, and there are two working commands so far (see below). However, it is still in the very-early stages of development.

Please join the discussions, add issues, and get involved.

Installation

git clone https://github.com/synek/codeline.git
poetry install

Development

Codeline can monitor the current directory for file-changes, and then run any commands it finds:
poetry run codeline --watch .

Alternatively you can run Codeline on a single file, executing any commands the file and then exiting.
poetry run codeline --run path/to/python/file.py

To build a command, copy the plugins/test_plugin as a starting point.

Commands

Currently, commands are implemented as Python plugins. The SDK for building commands is found in codeline/sdk.

Test

The test command doesn't do anything, but shows how commands work.

Example usage:

def some_function():
    # <| test run
    do_something()
    more_stuff()

If Codeline is monitoring the directory, then it will run the command when you save the file.

Commit

This command allows you to automatically commit a "hunk" of code.

Example usage:

# <| commit -m "Adds myfunc() to do something"
def myfunc(data):
    data.do_something()
    print("done")

If Codeline is monitoring the directory, then it will run the command when you save the file.

Future Work

Add support for shell scripts
Make it possible to pipe commands together
Publish documentation for the SDK

Contributing

Codeline is still under heavy development. I will start accepting PRs in a couple of weeks once the development has stabilised a little. However, if you'd like to make a new command for Codeline then please get in touch with me ([email protected]) or open an issue and I'll help.

You might also like...

A selfbot made with DPY, doesn't have much commands but there's some useful commands to use.

Phantom Selfbot A selfbot made in DPY, made by Zenith. How to use Add your token in token = 'YOUR-MOMS-TOKEN-HERE' Change the prefix in prefix = If

2 Dec 2, 2021

Pincer-ext-commands - A simple, lightweight package for pincer prefixed commands

pincer.ext.commands A reimagining of pincer's command system and bot system. Ins

2 Jan 11, 2022

Run your jupyter notebooks as a REST API endpoint. This isn't a jupyter server but rather just a way to run your notebooks as a REST API Endpoint.

Jupter Notebook REST API Run your jupyter notebooks as a REST API endpoint. This isn't a jupyter server but rather just a way to run your notebooks as

54 Nov 4, 2022

Comments

Default configuration options should be hard-coded and not require a `config.yaml` in `$HOME`

Right now, the default config is stored in a file which must be installed to the right location. It would be better if default configuration was simply defined in Python.

opened by synek 1

The git plugin should be able to commit a small hunk

Use-case:

def my_function():
    do_stuff()
    # <| git commit --now -m "fixes typo"
    some_class.do_something("constant")  # <| git commit --now -m "fixes typo"

It should support in-line commands or line-above commands.

enhancement plugin

opened by synek 1

[Feature] Codeline should introspect on plugins to determine subcommands and, if possible, arguments

For example, in the git plugin, Plugin.commit(context: Context, message: str = None" could be introspected to construct anArgumentParserwith the subcommandgitand--message/-m` as an argument.
enhancement

opened by synek 0

Run context-aware commands from your source code comments

Related tags

Overview

Current State

Installation

Development

Commands

Test

Commit

Future Work

Contributing

You might also like...

A selfbot made with DPY, doesn't have much commands but there's some useful commands to use.

Pincer-ext-commands - A simple, lightweight package for pincer prefixed commands

Run your jupyter notebooks as a REST API endpoint. This isn't a jupyter server but rather just a way to run your notebooks as a REST API Endpoint.

This is the source code for: Context-aware Entity Typing in Knowledge Graphs.

A python tool that creates issues in your repos based on TODO comments in your code

Purge your likes and wall comments from VKontakte. Set yourself free from your digital footprint.

A simple service that allows you to run commands on the server using text

Copy a Kubernetes pod and run commands in its environment

A hack to run custom shell commands when building documentation on Read the Docs.

Python package to parse and generate C/C++ code as context aware preprocessor.

Turn clang-tidy warnings and fixes to comments in your pull request

Stream comments, submissions from subreddits and users across reddit right in your terminal

Semi-supervised Semantic Segmentation with Directional Context-aware Consistency (CVPR 2021)

Semi-supervised Semantic Segmentation with Directional Context-aware Consistency (CVPR 2021)

IAUnet: Global Context-Aware Feature Learning for Person Re-Identification

Official PyTorch implementation of UACANet: Uncertainty Aware Context Attention for Polyp Segmentation

CAPRI: Context-Aware Interpretable Point-of-Interest Recommendation Framework

Line as a Visual Sentence: Context-aware Line Descriptor for Visual Localization

Unofficial implementation of Point-Unet: A Context-Aware Point-Based Neural Network for Volumetric Segmentation

Comments

Default configuration options should be hard-coded and not require a `config.yaml` in `$HOME`

The git plugin should be able to commit a small hunk

[Feature] Codeline should introspect on plugins to determine subcommands and, if possible, arguments

Releases(v0.1.0)

v0.1.0(Mar 14, 2021)

Owner

Rory Byrne

A Sublime Text package that allows a user to view all the available core/plugin commands for Sublime Text and Sublime Merge, along with their documentation/source.

Spyder - The Scientific Python Development Environment

An echo kernel for JupyterLite

A GitHub Action hosted Python IDE!

pyiron - an integrated development environment (IDE) for computational materials science.

💻 Open recent VS Code folders and files using Ulauncher

Clarity mode is a single-notebook interface built with existing JupyterLab components.

Python 3 patcher for Sublime Text v4107-4114 Windows x64

Mu - A Simple Python Code Editor

This is code for IDLE python/ Magic8Ball Code

CTO (Call Tree Overviewer) is an IDA plugin for creating a simple and efficiant function call tree graph

Automatically detect obfuscated code and other state machines

VSCode Development Container Template

A Python code editor that looks like GNU Emacs.

ROS2 Docker tutorial with VSCode

An amazing simple Python IDE for developers!

Kite IntelliJ plugin

Multi-user server for Jupyter notebooks

Launch a ready-to-code Wagtail Live development environment with a single click.

A way to integrate Latex, VSCode, and Inkscape in macOS. Adopted the whole workflow from Gilles Castel.