Metadata-Version: 2.4
Name: atopile
Version: 0.14.3
Summary: A toolchain bringing the best of software development to the real-world!
Project-URL: Homepage, https://github.com/atopile/atopile
Project-URL: Bug Tracker, https://github.com/atopile/atopile/issues
Author-email: Ioannis Papamanoglou <ioannis@atopile.io>, Narayan Powderly <narayan@atopile.io>
License: MIT License
        
        Copyright (c) 2024 atopile
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: <3.15,>=3.14
Requires-Dist: antlr4-python3-runtime==4.13.2
Requires-Dist: atopile-easyeda2kicad>=0.9.7
Requires-Dist: atopile-kicad-python>=0.5.1
Requires-Dist: black>=24.4.2
Requires-Dist: case-converter>=1.2.0
Requires-Dist: cookiecutter>=2.6.0
Requires-Dist: dataclasses-json>=0.6.7
Requires-Dist: deprecated~=1.2.14
Requires-Dist: fastapi-github-oidc>=0.2.1
Requires-Dist: fastapi>=0.110.0
Requires-Dist: freetype-py>=2.4
Requires-Dist: gitpython>=3.1.41
Requires-Dist: httpx>=0.28.1
Requires-Dist: jinja2>=3.1.6
Requires-Dist: kicadcliwrapper>=1.1.1
Requires-Dist: matplotlib>=3.7.1
Requires-Dist: mcp[cli]>=1.10.1
Requires-Dist: more-itertools>=10.4
Requires-Dist: nanobind>=2.6.1
Requires-Dist: natsort>=8.4.0
Requires-Dist: numpy>=2.2.0
Requires-Dist: ordered-set==4.1.0
Requires-Dist: pathvalidate>=3.2.1
Requires-Dist: platformdirs>=4.3.6
Requires-Dist: posthog==7.8.0
Requires-Dist: prompt-toolkit==3.0.51
Requires-Dist: psutil>=6.0.0
Requires-Dist: pydantic-settings>=2.7.1
Requires-Dist: pygls<3.0.0,>=2.0.0
Requires-Dist: pytest<10.0.0,>=9.0.0
Requires-Dist: questionary>=2.0.1
Requires-Dist: rich>=13.7.1
Requires-Dist: ruamel-yaml>=0.18.5
Requires-Dist: ruff>=0.11.0
Requires-Dist: semver>=3.0.2
Requires-Dist: sexpdata>=1.0.2
Requires-Dist: shapely>=2.0.1
Requires-Dist: truststore>=0.10.4
Requires-Dist: typer>=0.12
Requires-Dist: typing-extensions>=4.6.3
Requires-Dist: urllib3>=2.2.1
Requires-Dist: uvicorn>=0.29.0
Requires-Dist: watchdog>=4.0.0
Requires-Dist: websockets>=12.0
Requires-Dist: zstd>=1.5.6.7
Description-Content-Type: text/markdown

<h1 align="center">
    <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://github.com/atopile/atopile/assets/9785003/00f19584-18a2-4b5f-9ce4-1248798974dd">
    <source media="(prefers-color-scheme: light)" src="https://github.com/atopile/atopile/assets/9785003/d38941c1-d7c1-42e6-9b94-a62a0996bc19">
    <img alt="Shows a black logo in light color mode and a white one in dark color mode." src="https://github.com/atopile/atopile/assets/9785003/d38941c1-d7c1-42e6-9b94-a62a0996bc19" width="260">
    </picture>
</h1>

<p align="center">
  <a href="https://pypi.org/project/atopile/"><img alt="PyPI" src="https://img.shields.io/pypi/v/atopile.svg"></a>
  <a href="https://docs.atopile.io/"><img alt="Docs" src="https://img.shields.io/badge/docs-atopile.io-blue"></a>
  <a href="https://packages.atopile.io/"><img alt="Packages" src="https://img.shields.io/badge/packages-registry-brightgreen"></a>
  <a href="https://discord.gg/CRe5xaDBr3"><img alt="Discord" src="https://img.shields.io/badge/Discord-join-5865F2?logo=discord&logoColor=white"></a>
  <a href="LICENSE"><img alt="License" src="https://img.shields.io/badge/license-MIT-green"></a>
</p>

## Design circuit boards with code

Write hardware like software. atopile is a language, compiler, and toolchain for electronics—declarative `.ato` files, deep validation, and layout that works natively with KiCad.

<p align="center">
  <img src="assets/tool.jpeg" alt="atopile editor with a project open" width="1152">
</p>

## Why atopile

- Reusable modules instead of starting from scratch every time
- Capture intent with equations directly in your design
- Automatic parametric picking of discrete components

## Install

The easiest way is via the editor extension—it installs and manages `ato` for you:

- VS Code/Cursor extension: https://marketplace.visualstudio.com/items?itemName=atopile.atopile

Advanced setups and CLI installs: https://docs.atopile.io/atopile/guides/install

## Quickstart (2 minutes)

1. Install the extension (link above)

2. In the editor, run “atopile: Open Example” and pick one

3. Press the ▶ in the ato menu bar to build, or run `ato build` from the terminal

4. Open layout when ready

Notes:

- The ato menu bar is in the bottom-left of your VS Code/Cursor window
- KiCad is optional to get started. Without it, you won’t open the PCB, but builds still run and update the `.kicad_pcb`. Install later when you’re ready for layout: https://docs.atopile.io/atopile/quickstart

## How it works

- `ato` is a declarative language for electronics: modules, interfaces, units, tolerances, and assertions
- The compiler solves constraints, picks parts, runs checks, and updates your KiCad layout
- The extension adds language services and one‑click controls
  
Learn more: https://docs.atopile.io/atopile/essentials/1-the-ato-language

### Where atopile fits in

High-level steps:

- Requirements — capture specs with units, tolerances, and assertions
- Component selection — parametric picking, reuse proven modules
- Design capture — `.ato` modules and interfaces compose your system
- Layout — place and route in KiCad
- Checks — run design checks locally or in CI
- Build outputs — BOM, fabrication and assembly data, reports
- PCB fab/assembly — send outputs to your manufacturer

## Example Projects

- Open examples via the editor (“atopile: Open Example”) https://github.com/atopile/atopile/tree/main/examples
- NONOS — Open-source smart speaker https://github.com/atopile/nonos
- DSP - Open-source multi-channel DSP https://github.com/atopile/dsp
- AI-Pin — Vibe-coded Humane Pin https://github.com/atopile/ai-pin
- Hyperion — 300K nit display for raves https://github.com/atopile/hyperion
- Cellsim - 18 channel battery cell simulator https://github.com/atopile/cellsim
- ESPaper - ESP32 epaper display driver https://github.com/atopile/hivehaus/tree/master/src/products/espaper

## Packages and parts

- Browse and install modules from the registry: https://packages.atopile.io
- Guide: https://docs.atopile.io/atopile/essentials/4-packages
- Publish your own: https://docs.atopile.io/atopile/guides/publish

## Compatibility

- OS: macOS, Linux, Windows (WSL recommended)
- Recommended editors: VS Code / Cursor
- EDA: KiCad recommended for layout; not required to start

## Contributing and development

- Development setup: https://docs.atopile.io/atopile/guides/development
- Editable install (for working on atopile itself): https://docs.atopile.io/atopile/guides/install#editable-installation-best-for-development
- Run tests:

```sh
pytest -q
```

- Fast worktree setup (CoW-clone `.venv` + Zig cache/output, then `pip install -e`):

```sh
ato dev worktree <new-branch-name>
cd ../<new-branch-name>
./ato --help
```

- Issues and feature requests: https://github.com/atopile/atopile/issues

## Support

- Discord “help” channel: https://discord.gg/CRe5xaDBr3
- Commercial support: hi@atopile.io

## License

MIT. See `LICENSE`.
