Skip to main content

A tool to easily automatically write all your source code to a JSON file and the other way around

Project description

Code 2 JSON

A command line utility that can insert code into JSON files and extract code from JSON to insert into a source code file.

Features

  • Create your source code in a separate file and have them be automatically written to JSON with in source markup
  • Write all files in a directory and it's subdirectories to the json
  • Specify the extension of the source code files
  • Specify the delimiter of the identifiers in the source code used to indicate the marked up parts (useful if the language does not support the default delimiter (//)
  • Update the source code based on the source code in the JSON

Planned features

  • A safe mode that allows the user to check the made changes before committing to them

Requirements

  • Python 3: I use print functions in the Python 3 style and I just don't feel like support Python 2 especially since it won't be supported after 2020/01/01
  • (Optionally) Pip: The Python Package Installer can be used to easily install Code 2 JSON but this can also be done by hand

Installation

There are multiple ways to install Code 2 JSON:

Using pip and PyPi

Simply run the following command

pip install code2json

Cloning the repository and installing with pip

  1. Clone the repository
git clone https://gitlab.com/Deathray_II/code2json.git

of if you prefer to use SSH

git clone git@gitlab.com:Deathray_II/code2json.git
  1. go inside the git directory
cd code2json
  1. run pip install on the setup file
pip install .

or if you wish to install it for just your user

pip install --user .

Cloning the repository and manually installing (on Linux)

  1. Clone repository
git clone https://gitlab.com/Deathray_II/code2json.git

of if you prefer to use SSH

git clone git@gitlab.com:Deathray_II/code2json.git
  1. Make accessible in your shell There are two ways to do this either adding an alias or link it into your /usr/bin folder
    • Adding an alias: Got to your ~/.bashrc or ~/.zshrc and add the line alisas code2json=/path/to/cmd.py "$@", where /path/to/cmd.py is the path to the cmd.py file in the src/code2json/ folder in the repository.
    • linking it into your /usr/bin: run (as a user who has access to write in /usr/bin) the command ln -s /path/to/cmd.py /usr/bin/code2json, where /path/to/cmd.py is the path to the cmd.py file in the src/code2json/ folder in the repository.

Usage

If you have cloned the repository you can have a look at the test files and try some of the command on them so you get an idea of how it works

Code to JSON

If we wish to write all the code from a file (apples.c) to the corresponding JSON file we would execute the the following command from the folder that contains our source file

code2json ./apples.c .c 2json

If we wish to write all the .js file underneath the current directory to their JSON file we would run the following command.

code2json . .js 2json

JSON to code

code2json ./apples.c .c 2code
code2json . .js 2json

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for code2json, version 0.1.0
Filename, size & hash File type Python version Upload date
code2json-0.1.0-py3-none-any.whl (13.6 kB) View hashes Wheel py3
code2json-0.1.0.tar.gz (9.7 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page