Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@hat-core/renderer

0.4.0-dev20200812 • Public • Published

Hat Core - remote control and monitoring framework core

Hat Open is open-source framework of tools and libraries for developing applications used for remote monitoring, control and management of intelligent electronic devices such as IoT devices, PLCs, industrial automation or home automation systems.

Hat Core is part of Hat Open providing collection of components and libraries on which Hat Open system is based.

Development of Hat Open and associated repositories is sponsored by Končar - Power Plant and Electric Traction Engineering Inc. (Končar KET

For more information see:

::: {.warning} ::: {.title} Warning :::

This project is currently in state of active development. Features, functionality and API are unstable. :::

Installation

Hat Open consists of multiple interconnected parts. Each part implements a specific functionality. For easier reusability, provided implementation is split into multiple packages:

Python packages

Python packages require Python 3.8 and can be installed with `pip`:

$ pip install <package-name>

where package-name is one of following:

JavaScript packages

JavaScript packages can be installed with `npm`:

$ npm install <package-name>

where package-name is one of following:

Build

Build tool used for Hat is pydoit ([http://pydoit.org/]{.title-ref}). It can be installed with [pip]{.title-ref} by running:

$ pip install doit

For listing available doit tasks, use:

$ doit list

Default task:

$ doit

creates [dist]{.title-ref} folder containing built packages.

Dependencies

Package managers used for managing dependencies:

  • pacman

    Package manager of Arch linux distribution. Available on Windows as part of [msys2]{.title-ref} (http://www.msys2.org/).

  • pip

    Package manager available as part of CPython installation.

  • yarn

    Package manager for NodeJS.

List of all dependencies for building and running hat components is available in:

  • requirements.pacman.win.txt (windows only)
  • requirements.pacman.linux.txt (archlinux only)
  • requirements.pip.txt
  • package.json

Python code targets CPython 3.8 only.

Documentation

Documentation can be built with:

$ doit docs

which creates [build/docs]{.title-ref} folder containing documentation.

Keywords

none

Install

npm i @hat-core/renderer

DownloadsWeekly Downloads

10

Version

0.4.0-dev20200812

License

MIT

Unpacked Size

12.5 kB

Total Files

3

Last publish

Collaborators

  • avatar