Giter Site home page Giter Site logo

codelephant's Introduction

Codelephant

Description

This is a command-line interface (CLI) tool written in Python. It accepts a directory as an argument and lists out all the files within the directory and subdirectories. It also provides a summary of the ratio of different files within the directory.

Installation

Prerequisites

Make sure you have the following prerequisites installed on your machine:

  • Python 3.x

Clone the Repository

  1. Open a terminal.
  2. Clone the repository using the following command:

git clone https://github.com/kylelwm/codelephant-poc.git

  1. Navigate to the project directory:

cd codelephant-poc

Install Dependencies

  1. Create a virtual environment (optional but recommended):

python3 -m venv venv

  1. Activate the virtual environment:

source venv/bin/activate

  1. Install the required dependencies:

pip install -r requirements.txt

Usage

  1. In the terminal, navigate to the project directory if you haven't already done so.

  2. Run the CLI tool with the following command: sh exec.sh /path/to/directory

Replace /path/to/directory with the actual directory path you want to process.

Usage running docker locally

  1. Build the image docker build . -t codelephant

  2. Run the CLI tool on the current directory with the following command: docker run -it --volume $(pwd):/app codelephant

Usage running from Docker Hub image

docker run -it --volume $(pwd):/app kylelwm/codelephant

Examples

Given the following directory structure:

/some/path
    /a.py
    /another/path
        /b.js

The output should be:

{
    "summary": {
        "python": 0.5,
        "js": 0.5
    },
    "results": [
        {
            "path": "/some/path/a.py",
            "language": "python"
        },
        {
            "path": "/some/path/another/path/b.js",
            "language": "js"
        }
    ]
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.