Skip to main content

​
Welcome to myos

myos is a Python library that provides a simple, object-oriented interface for managing OpenStack cloud resources. It wraps the OpenStack CLI commands in a clean API that makes it easy to query and manipulate users, projects, servers, hypervisors, and other cloud resources.

Quick Start

Get up and running with myos in minutes

Installation

Install myos and configure your environment

API Reference

Explore the complete API documentation

Examples

Learn from real-world usage examples

​
Key Features

Object-Oriented Design

Work with cloud resources as Python objects with intuitive properties and methods

Lazy Loading

Data is fetched only when needed, keeping your queries efficient

Relationship Traversal

Navigate between related resources easily (user → projects → servers)

Multi-Cloud Support

Connect to different OpenStack cloud environments with flexible configuration

Custom Collections

EntityList provides filter, sort, and map operations for working with resource collections

Comprehensive Coverage

Manage users, projects, servers, hypervisors, flavors, images, IPs, quotas, and more

​
Quick Example

Here’s how easy it is to get information about a user and their projects: 
from myos.user import User

# Get user information
user = User(name='username', domain_name='stfc')
print(user.id)
print(user.email)

# List all projects the user has access to
for project in user.projects:
    print(f"{project.id} - {project.name}")

​
Why myos?

Managing OpenStack infrastructure often requires running multiple CLI commands and parsing JSON output. myos eliminates this complexity by:
  • Simplifying queries - No need to remember complex CLI commands or parse JSON
  • Providing relationships - Easily navigate from users to projects to servers
  • Enabling efficient queries - Lazy loading ensures you only fetch data when needed
  • Supporting reusable patterns - Write clean, maintainable infrastructure management code

​
What’s Next?

Installation Guide

Set up myos and configure OpenStack credentials

Quick Start Tutorial

Build your first myos script in under 5 minutes

Core Concepts

Understand how myos works under the hood

User Guide

Learn how to manage users and permissions

Build docs developers (and LLMs) love

Get started for freeTalk to us