Metadata-Version: 2.1
Name: electronic-symbol-generator-for-cad-by-sporniket
Version: 0.0.3
Summary: Electronic symbol generator for CAD, a library with a command line interface to generate symbols of electronic packages for electronic CAD suites like Kicad.
Keywords: Kicad,symbol generator
Author-Email: Sporniket <sporniket.studio@gmail.com>
License: GPL-3.0-or-later
Project-URL: homepage, https://github.com/sporniket/electronic-symbol-generator-for-cad
Project-URL: repository, https://github.com/sporniket/electronic-symbol-generator-for-cad
Project-URL: bug-tracker, https://github.com/sporniket/electronic-symbol-generator-for-cad/issues
Requires-Python: >=3.12
Requires-Dist: electronic-package-descriptor-by-sporniket<1.1.0
Description-Content-Type: text/markdown

# Sporniket's electronic symbol generator for CAD

[![Latest version](https://img.shields.io/github/v/release/sporniket/electronic-symbol-generator-for-cad?include_prereleases)](https://github.com/sporniket/electronic-symbol-generator-for-cad/releases)
[![Workflow status](https://img.shields.io/github/workflow/status/sporniket/electronic-symbol-generator-for-cad/Python%20package)](https://github.com/sporniket/electronic-symbol-generator-for-cad/actions/workflows/python-package.yml)
[![Download status](https://img.shields.io/pypi/dm/electronic-symbol-generator-for-cad-by-sporniket)](https://pypi.org/project/electronic-symbol-generator-for-cad-by-sporniket/)

> [WARNING] Please read carefully this note before using this project. It contains important facts.

Content

1. What is **Sporniket's electronic symbol generator for CAD**, and when to use it ?
2. What should you know before using **Sporniket's electronic symbol generator for CAD** ?
3. How to use **Sporniket's electronic symbol generator for CAD** ?
4. Known issues
5. Miscellanous

## 1. What is **Sporniket's electronic symbol generator for CAD**, and when to use it ?

**Sporniket's electronic symbol generator for CAD** is a python library with a command line interface to generate symbols of electronic packages for electronic CAD suites like Kicad.


### Licence

**Sporniket's electronic symbol generator for CAD** is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

**Sporniket's electronic symbol generator for CAD** is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

### Release notes

#### v0.0.3

Provides an entry point : `elsygen`.

#### v0.0.2

* Resolves #3 : [bug]Functionnal, multi-unit : AMPOP_VREF groups should not place V+ on the north side

#### v0.0.1

* First packaged version, supports 'json' and 'kicad5' format only

## 2. What should you know before using **Sporniket's electronic symbol generator for CAD** ?

**Sporniket's electronic symbol generator for CAD** is written using python version 3.8, and should work with python version to 3.10.

It relies on the following packages to build and test :

* build
* pytest
* coverage

It also relies on the following package to enforce source formatting :

* black

see [README packaging](https://github.com/sporniket/electronic-symbol-generator-for-cad/blob/main/README-packaging.md) for further details.

**Sporniket's electronic symbol generator for CAD** is build upon [Sporniket's electronic package descriptor](http://github.com/sporniket/electronic-package-descriptor) and its file format specifications.

> Do not use **Sporniket's electronic symbol generator for CAD** if this project is not suitable for your project.

## 3. How to use **Sporniket's electronic symbol generator for CAD** ?

### From sources

> Some python modules are required
>
> ```
> pipx install --upgrade pdm
> ```
>

Clone the git repository, get all the dependencies :

	git clone https://github.com/sporniket/electronic-symbol-generator-for-cad.git
	cd electronic-symbol-generator-for-cad
	pdm sync

Then, invoke the command line interface :

```
python3 -m electronic_symbol_generator_for_cad [option] input_file
```

### Using pipx

```
pipx install electronic-symbol-generator-for-cad-by-sporniket
```

Then, invoke the command line interface :

```
elsygen [option] input_file
```

## 4. Known issues
See the [project issues](https://github.com/sporniket/electronic-symbol-generator-for-cad/issues) page.

## 5. Miscellanous

Supplemental documentation :

* [README packaging](https://github.com/sporniket/electronic-symbol-generator-for-cad/blob/main/README-packaging.md) : some technical details about packaging this project.
* [README cli](https://github.com/sporniket/electronic-symbol-generator-for-cad/blob/main/README-cli.md) : the manual of the command line interface.
* [README json](https://github.com/sporniket/electronic-package-descriptor/blob/main/README-json.md) : the specification of the JSON-based format.
* [README datasheet](https://github.com/sporniket/electronic-package-descriptor/blob/main/README-datasheet.md) : the specification of the Markdown-based datasheet structure.

### Report issues
Use the [project issues](https://github.com/sporniket/electronic-symbol-generator-for-cad/issues) page.
