Developer Guide

The Developer Guide is intended for developers and provides support for creating new features for nessy.

Project Layout

This section is supposed to give you an overview about the repository structure to make it easier to find your way around.

The following structure might not be comprehensive

├── Makefile: "Defines common tasks like linting or testing."
├── pyproject.toml: "Defines the python package and dependencies."
├── 📁 azure-pipelines: "Cloe Standard Pipelines"
├── 📁 docs
│   ├── 📁 Developer-Guide: "Developer focussed documentation."
│   ├── 📁 Reference: "Reference created from docstrings."
│   ├── 📁 User-Guide: "User focussed documentation."
├── 📁 src
│   ├── 📁 cloe_nessy: "The python package source."
│   │   ├── 📁clients: "Universally useful clients."
│   │   │   └── 📁api_client
│   │   ├── 📁file_utilities: "Discovery of files in different environments."
│   │   ├── 📁integration: "Data Integration solutions."
│   │   │   ├── 📁reader
│   │   │   └── 📁writer
│   │   ├── 📁logging
│   │   ├── 📁models: "E.g., Schema, Table and Column."
│   │   ├── 📁object_manager
│   │   ├── 📁pipeline
│   │   │   ├── 📁actions: "Action definitions."
│   │   │   ├── pipeline.py: "The Pipeline object."
│   │   │   ├── ...
│   │   ├── 📁session
│   │   ├── 📁settings
│   │   ├── ...
├── 📁tests: "Tests for the package."