Metadata-Version: 2.1
Name: a28
Version: 0.1.1
Summary: A set of resources and tools to help developers create packages for the Area28 application.
Home-page: https://area28.io
License: MIT
Author: Gary Stidston-Broadbent
Author-email: pypi@garysb.com
Requires-Python: >=3.7,<4
Classifier: Environment :: Console :: Curses
Classifier: Environment :: X11 Applications :: Qt
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: coloredlogs[color] (>=14.0)
Requires-Dist: requests (>=2.23.0,<3.0.0)
Description-Content-Type: text/markdown

# Developer Toolkit

Developer Toolkit providing developers with the tools and documentation necessary to build packages for the Area28 Application.

## Python version

Area28 follows [https://vfxplatform.com/] which restricts Python to 3.7.x currently.

## Interfaces

- IPlugin
- IApiExtension
- IApplicationExtension
- IChatExtension
- IEventExtension
- IInteractionExtension
- ILoggerExtension
- IMetadataExtension
- IPreferencesExtension
- IRealtimeExtension
- IUiExtension
- IUnitsExtension

## Plugins

Plugins are decorators that can be used to manipulate the payload before being processed or before getting returned.

## Extensions

Extension are used to add additional functionality to the Area28 application. Extensions are broken up into multiple types, defined within the Interfaces list.

## Packaging

Each package has a unique identifier associated with it and is compressed into a .a28 file. Please look at the a28 development kit for details.

### Package structure

The package structure is as follows:

@{provider}/{package}
    extensions/{extensions[]}.py
    scripts/
    scripts/install.py
    scripts/postinstall.py
    scripts/preinstall.py
    scripts/uninstall.py
    plugin/{application specific plugin}
    plugins/{plugin[]}.py
    bin/{executable[]}.py
    package.json

### Package.json structure

```javascript
{
  "name": "@area28/unity-application",
  "version": "0.0.4",
  "description": "Detect is running within Unity3D.",
  "homepage": "https://area28.io",
  "keywords": [
    "area28",
    "chat",
    "lowercase",
    "transform"
  ],
  "repository": {
    "type": "git",
    "url": "git+https://github.com/area28/area28.git",
    "directory": "packages/unity-application"
  },
  "author": "Gary Stidston-Broadbent",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/area28/area28/issues"
  },
  "bin" : {
    "myapp" : "./bin/lowercase.py"
  },
  "os" : [
    "darwin",
    "linux"
  ],
  "cpu" : [
    "x64",
    "ia32",
    "!mips"
  ],
  "scripts": {
    "preinstall": "scripts/preinstall.py",
    "install": "scripts/install.py",
    "postinstall": "scripts/postinstall.py",
    "uninstall" : "scripts/uninstall.py"
  }
}
```

### Building a package

- `a28 build --src @area28/chat-logger --dest dist`

### Installing a package locally

- `a28 install --pkg dist/00000000-0000-0000-0000-00000000-0.0.1.a28`

