markgacoka / codepropertygraph

A Python implementation of a language-agnostic Code Property Graph

Installation

To install the repository, you need to clone it and run it inside a virtual environment. Running main.py generates a Code Property Graph of the simple addition script inside examples/ and saves it to output/.

git clone https://github.com/markgacoka/codepropertygraph.git
cd codepropertygraph

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Running the Application

python main.py

Testing

Run all tests

pytest codepropertygraph/tests

Updating Library

1. Upgrade the version number in codepropertygraph/setup.py

--> VERSION="x.x.x"

2. Upload to Pypi

python setup.py sdist bdist_wheel
twine upload dist/*

If API token is requested, go to .env as PYPI_API_TOKEN.

For first time contributors, read the CONTRIBUTING page.