Documentation for Devinstaller Core

Note

If you are looking for information on how to use a Devinstaller application then you are at the wrong place.

Please refer to the docs by the respective Devinstaller application.

This doc is meant for developers who would like to create a Devinstaller Application.

What is a Devinstaller application?

1 What is Devinstaller Core?

Devinstaller Core is a Python based Application Engine for the Devinstaller system.

This library is used to create your end user applications.

User Guide

Table of Contents

• The Design process
  • Motivation
  • Initial design
  • Improved design
• User Guide
  • What is the Devinstaller system?
  • What is this library?
    • What is devinstaller files?
    • How it works?
      • Step 1: Identify your needs
      • Step 2: Install a Devinstaller application for that need
      • Step 3: Write the spec file to execute your instructions
      • Step 4: Execute
  • How to use this library?
• The Implementation
  • Introduction
    • The specification file
    • The program file
    • The Devinstaller runtime
      • The runtime core
      • The execution handler
• API
  • Modules
    • Utility modules
      • Commands
      • Exceptions
      • File manager
      • Schema
      • Utilities
  • Modules
    • Common Module
      • Common models
    • Base Module
      • Base module
    • Modules
      • App module
      • File module
      • Folder module
      • Group module
      • Link module
      • Phony module
  • Blocks
    • Platform Block
    • Interface Block
  • Dependency Graph
    • Dependency Graph
  • Extensions
    • Creating Extensions
      • Extension module
    • Builtin Extensions
      • Python Extension for Command module
      • Shell Extension for Command module
• Error codes
  • Specification errors
  • Devinstaller errors
• Contributing
  • Prerequisites
    • Python 3.8
    • Poetry
    • Tox
  • Develop
    • For developers install normal and dev dependencies
    • Install dev dependencies
    • Install normal dependencies
    • Use poetry shell
  • Testing
    • Testing using Gitlab runner locally
      • Gitlab runner requirements
      • Install gitlab-runner locally
      • Running the tests
  • Coverage report
  • Facing any problems
    • Issue with installing poetry packages
      • Copy paste this line into your ~/.bash_profile or ~/.zshrc.
      • Reinstall Python using brew
  • Git
  • Changelog
    • Usage
  • Versioning
    • Commands
      • To bump up major version
      • To bump up minor version
      • To bump up patch version
  • Type checking
    • Stub generation
  • About the dependency files
    • For developing the application
    • For building the docs
• Glossary

Indices and tables

• Index

• Module Index

• Search Page