https://github.com/rakhimov/cppdep

C/C++ Dependency Analyzer: a rewrite of John Lakos' dep_utils (adep/cdep/ldep) from "Large-Scale C++ Software Design"
https://github.com/rakhimov/cppdep

c-plus-plus dependency-analysis metrics quality

Last synced: 3 days ago
JSON representation

C/C++ Dependency Analyzer: a rewrite of John Lakos' dep_utils (adep/cdep/ldep) from "Large-Scale C++ Software Design"

• Host: GitHub
• URL: https://github.com/rakhimov/cppdep
• Owner: rakhimov
• License: gpl-3.0
• Created: 2016-09-25T14:47:27.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-01-16T22:55:07.000Z (almost 3 years ago)
• Last Synced: 2024-12-13T10:39:31.429Z (10 days ago)
• Topics: c-plus-plus, dependency-analysis, metrics, quality
• Language: Python
• Homepage:
• Size: 298 KB
• Stars: 141
• Watchers: 11
• Forks: 19
• Open Issues: 17
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
######

|logo|

######

.. image:: https://travis-ci.org/rakhimov/cppdep.svg?branch=master

    :target: https://travis-ci.org/rakhimov/cppdep

.. image:: https://ci.appveyor.com/api/projects/status/1ff39sfjp7ija3j8/branch/master?svg=true

    :target: https://ci.appveyor.com/project/rakhimov/cppdep/branch/master

    :alt: 'Build status'

.. image:: https://codecov.io/gh/rakhimov/cppdep/branch/master/graph/badge.svg

  :target: https://codecov.io/gh/rakhimov/cppdep

.. image:: https://landscape.io/github/rakhimov/cppdep/master/landscape.svg?style=flat

   :target: https://landscape.io/github/rakhimov/cppdep/master

   :alt: Code Health

.. image:: https://badge.fury.io/py/cppdep.svg

    :target: https://badge.fury.io/py/cppdep

|

``cppdep`` performs dependency analysis

among components/packages/package groups of a large C/C++ project.

This is a rewrite of ``dep_utils(adep/cdep/ldep)``,

which is provided by John Lakos' book

"Large-Scale C++ Software Design", Addison Wesley (1996).

.. |logo| image:: logo.png

Limitations

===========

- Indirect `extern` declarations of global variables or functions

  instead of including the proper component header with the declarations.

- Embedded dynamic dependencies,

  such as dynamic loading and configurable internal services.

- Preprocessing or macro expansion is not performed.

  Dependency inclusion via preprocessor *meta-programming* is not handled.

- Dependency exclusion with C style multi-line comments or macros

  is not respected.

Requirements

============

#. Python 2.7 or 3.4+

#. `NetworkX `_

#. pydot

#. pydotplus

#. PyYAML

#. PyKwalify 1.6.0+

The dependencies can be installed with ``pip``.

.. code-block:: bash

    $ sudo pip install -r requirements.txt

Installation

============

From the source:

.. code-block:: bash

    $ ./setup.py install

The latest stable release from PyPi:

.. code-block:: bash

    $ pip install cppdep

Usage

=====

Create a configuration file

that describes the project for analysis.

``config_schema.yml`` is given for guidance.

In the root directory of the project with the configuration file,

run the following command to generate dependency analysis reports and graphs.

.. code-block:: bash

    $ cppdep -c /path/to/config/file

More documentation and example configurations

can be found in project `wiki `_.

Acknowledgments

===============

- John Lakos for inventing the analysis and providing ``dep_utils``.

- `Zhichang Yu `_ for rewriting ``dep_utils`` into Python.