PySquared

PySquared is a CircuitPython-based CubeSat flight software library with flight heritage. It provides robust, modular components for spacecraft control, telemetry, configuration, and hardware management.

Features

• Modular architecture for easy extension and customization
• Type-checked protocols and sensor interfaces
• Robust error handling and JSON-structured logging
• Configuration management with validation
• High test coverage
• Designed for microcontroller resource constraints

Quick Start

Using PySquared for your Satellite

If you are looking to use PySquared in your own project, see the Getting Started guide.

Contributing to PySquared

If you want to contribute to PySquared, follow these steps:

1. Clone the repository:

   git clone https://github.com/proveskit/pysquared.git
   cd pysquared
   

2. Install dependencies using uv:

   make
   

3. Run tests:

   make test
   

4. See the contributing guide for more details.

Documentation

• Getting Started
• Design Guide
• Configuration
• Error Handling & Logging
• API Reference
• Contributing

Supported Platforms

• PROVES Kit hardware
• Devices supported by CircuitPython

Contributing

We welcome contributions! Please read our contributing guide and design guide before submitting changes. If you have questions, open an issue or discussion.