https://github.com/pluots/pyaltium
A python package that allows interface of Altium files
https://github.com/pluots/pyaltium
Last synced: about 2 months ago
JSON representation
A python package that allows interface of Altium files
- Host: GitHub
- URL: https://github.com/pluots/pyaltium
- Owner: pluots
- License: gpl-3.0
- Created: 2021-09-17T03:45:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-25T01:06:55.000Z (almost 2 years ago)
- Last Synced: 2025-03-29T17:51:12.282Z (3 months ago)
- Language: Python
- Size: 5.6 MB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PyAltium
NOTE: This tool is currently broken and incomplete, and is awaiting a rewrite!
I have a rewrite in Rust that is significantly more usable ([documentation](http://docs.rs/altium)
and [repository](https://github.com/pluots/altium)). Python bindings are a long way
off, but contributions there are welcome!
---
A tool to process Altium file types. Currently this tool is in alpha and does not have any parts fully functioning, except for the listing of PCBLib and SCHLib libraries.
See full documentation here (WIP): [pyaltium.readthedocs.io](http://pyaltium.readthedocs.io)
## Project Progress
The goal of this project is to support most file types used by Altium. Reading is a priority, writing will be implemented for some types. The status of various file types is listed below:
| | Extension | List Items | Display | Write | Documentation |
| ------------------------ | ----------- | ---------- | ------- | ----- | ------------------------------------- |
| Binary Schematic Library | .SchLib | ✓ | WIP | | WIP |
| Binary PCB Library | .PcbLib | ✓ | WIP | | WIP |
| Binary Schematic Doc | .SchDoc | | | | |
| Binary PCB Doc | .PcbDoc | | | | |
| Draftsman Doc | .PcbDwf | | | | |
| PCB Project | .PrjPcb | | | | |
| Material Library | .xml | ✓ | N/A | ✓ | WIP (see test_matlib in the meantime) |
| Any templates | Not Planned | | | | |
## Usage
### SchLib
Sample usage:
```python
import pprint
from pyaltium import SchLib
# Set up our pretty printer so our output is understandable
pp = pprint.PrettyPrinter(indent=4)
sl = SchLib("myfile_name.SchLib")
pp.pprint(SchLib.list_items())
```
This returns something like the following with more elements:
```JSON
[
{
"libref": "ref1",
"description": "My description",
"sectionkey": "Section Key" // This is unneeded, just for internals
}
]
```
### PCBLib
Currently the only PCB library capability is creating a list of footprints
Sample usage:
```python
import pprint
from pyaltium import SchLib
# Set up our pretty printer so our output is understandable
pp = pprint.PrettyPrinter(indent=4)
sl = SchLib("myfile_name.SchLib")
pp.pprint(SchLib.list_items())
```
Returns:
```JSON
[
{
"footprintref": "ref1",
"height": "2.8", // mm
"description": "My description"
},
// ...
]
```
## Contributing
Have an idea? Open an issue! Have a change? submit a PR!
Note that I have a long ways to go on this so don't expect too much as of now.
Help is always welcome.
## Licensing
This project is licensed under GPLv3. Basically you can use this however you
want but if you distribute (aka sell) something with it, you need to make
the source available. Once this project gains some traction, I'll be open to
moving to MIT if there's demand for it.