Metadata-Version: 2.1
Name: shipyard-urbit
Version: 0.1.1
Summary: Urbit hosting and automation platform
License: Apache-2.0
Author: nodreb-borrus
Author-email: nodreb@borr.us
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: docker[ssh] (>=5.0.3,<6.0.0)
Requires-Dist: fastapi (>=0.79.0,<0.80.0)
Requires-Dist: typer[all] (>=0.6.1,<0.7.0)
Requires-Dist: uvicorn[standard] (>=0.18.2,<0.19.0)
Description-Content-Type: text/markdown

# Shipyard

Urbit hosting and automation platform.

Note: this is a Pre-Release package.  All changes will be breaking.  Wait for release 1.0.0 or later.

## Install

```
pip install shipyard-urbit
```

## Usage

```
shipyard
```

## API Overview

Visit [redacted] for full API Documentation.

## Development

### Modules

#### shipyard

 * `models.py` - types used throughout the project
 * `multi.py` - process management utilities

#### shipyard.api

HTTP API built with FastAPI.

#### shipyard.cli

Command-line interface built with Typer.

#### shipyard.colony

Host setup and configuration using Ansible.

#### shipyard.deploy

Creating and migrating Urbit ships within our host infrastructure.

#### shipyard.envoy

Communication and direction of Urbit ships.

#### shipyard.vigil

Monitoring and alerting. WIP.

## License

This project is licensed under Apache-2.0.  Code licensed from other projects will be clearly marked with the appropriate notice.

