archan 1.0.0

A Python module that analyses your achitecture strength based on DSM data.

Overview

A Python module that analyses your achitecture strength based on DSM data.

Archan is a Python module that analyzes the strength of your project architecture according to some criteria described in “The Protection of Information in Computer Systems”, written by Jerome H. Saltzer and Michael D. Schroeder.

Archan is used in combination with dependenpy in the Django app called django-meerkat.

License

Software licensed under MPL 2.0 license.

Installation

Just run pip install archan.

Usage

Archan takes a dependency matrix as parameter. It is a list of list of numeric values, representing the dependencies between the packages that are used in your project. It also needs the keys (one string for each row of the matrix), and their associated group type.

In django-meerkat, these data are provided by the dependenpy Python module, but you can build and use your own:

from archan.dsm import DesignStructureMatrix
from archan.checker import Archan

my_matrix = [[0, 1, 2, 0],
             [1, 1, 1, 0],
             [0, 0, 0, 3],
             [3, 3, 0, 1]]

my_keys = ['core', 'some_app', 'whatever', 'feature']
my_groups = ['core_lib', 'app_module', 'app_module', 'app_module']

my_dsm = DesignStructureMatrix(my_groups, my_keys, my_matrix)
archan = Archan()
results = archan.check(dsm)
print(results)

Documentation

https://github.com/Pawamoy/archan.wiki

Development

To run all the tests: tox

Changelog

0.1.0 (2016-10-06)

• Alpha release on PyPI.