pylint-hexagonal 0.0.1

No project description provided

pylint-hexagonal

---

Table of Contents

• Introduction
• Installation
• License

Introduction

This is a pylint plugin for use with a with a package structure as follows:

example/
├── adapters
│   ├── api
│   │   └── api.py
│   └── db
│       └── db.py
└── core
    ├── application
    │   └── service.py
    ├── domain
    │   └── aggregate.py
    └── ports
        ├── primary
        │   └── serviceport.py
        └── secondary
            └── daoport.py

The checker validates the following hexagonal architecure rules:

1. Core modules must not import from adapters
2. Adapter modules must not import from other adapters
3. Adapter modules modules should only import from the ports subpackage of the core.
4. Ports should not include any logic (abstract classes and methods only)

Installation

pip install pylint-hexagonal

License

pylint-hexagonal is distributed under the terms of the MIT license.