Metadata-Version: 2.1
Name: PyAltium
Version: 0.3.0
Summary: A package for reading Altium files
Home-page: https://github.com/pluots/PyAltium
Author: Trevor Gross
Author-email: t.gross35@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/pluots/PyAltium/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# PyAltium

A tool to process Altium file types. Currently only supports reading of .SchLib files.

## Information & Usage

### SchLib

Currently the only schematic library capability is creating a list of
library items, with some details

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')
print(SchLib.list_items())

```

Returns

```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')
print(SchLib.list_items())

```

Returns:

```JSON
[
    {
        "footprintref": "ref1",
        "height": "2.8", // mm
        "description": "My description"
    },
    // ...
]
```


