Giter Club home page Giter Club logo

project_mole's Introduction

Project Mole

Overview

This Python script, app.py, is designed to scan all the files in the repository (excluding directories, markdown files, the script itself, and hidden files) and generate a JSON object that includes the path and content of each file. This JSON object is useful for creating project documentation or summaries, such as automatically generating a README file for the project.

Features

  • Scans all files in the project directory recursively.
  • Filters out directories, markdown (.md) files, the script file itself, and hidden files.
  • Outputs the paths and contents of the scanned files in a structured JSON format.

Usage

To use this script, run it with an argument specifying the output file path for the JSON. The command to run the script would look like this:

python app.py <output_file_path>

For example, to generate a project context file named project_context.json, you would run:

python app.py project_context.json

This command will create a context.json file that contains the path and content of each file in the project directory, structured as a JSON array of objects.

Contributing

Contributions to enhance the functionality of this script are welcome. Please ensure any pull requests are well-documented and include updates to this README if necessary.

License

This project is open-sourced under the MIT License. See the LICENSE file for more details.

project_mole's People

Contributors

otanadzetsotne avatar

Watchers

 avatar

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.