Merge pull request #8 from mvnmgrx/pypi_release

Support for Python Package Index (PyPI)
mvnmgrx · Jun 15, 2022 · 8d609cd · 8d609cd
2 parents 1404529 + cac59f4
commit 8d609cd
Show file tree

Hide file tree

Showing 20 changed files with 64 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,5 +12,8 @@
 # Other stuff
 *.log
 
-# Releases
-output/
+# Releases and build stuff
+output/*
+dist/*
+build/*
+src/kiutils.egg-info/*
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # kiutils - CHANGELOG
 
+## v1.1.0 - 16.06.2022
+- Added: Support for Python Package Index (PyPI)
+- Changed: Source directory for development moved from `kiutils/` to `src/kiutils/`
+
 ## v1.0.1 - 15.06.2022
 - Added: Dimension, DimensionStyle, DimensionFormat classes for dimensions (measurements in PCB)
 - Added: Target class for board target markers

diff --git a/README.md b/README.md
@@ -15,6 +15,23 @@ Parsing of the files is based on the S-Expression parser found in this library:
 The following is required to use `kiutils`:
 - Python 3.10 or higher
 
+## Installation and usage
+KiUtils is available on [PyPI](https://pypi.org/project/kiutils/). Use Python's `pip` 
+to install it:
+```
+pip install kiutils
+```
+
+The most relevant classes can then be imported like this:
+```python
+from kiutils.board import Board
+from kiutils.libraries import LibTable
+from kiutils.schematic import Schematic
+from kiutils.footprint import Footprint
+from kiutils.symbol import SymbolLib
+```
+Check the [Structure]() section on all importable classes or the [Examples]() section for code snippets.
+
 ## Structure
 The module features the following classes:
 ```python
@@ -109,6 +126,14 @@ The module features the following classes:
   + board.py
   | - Board()               # Board files (.kicad_pcb)
   |
+  + footprint.py
+  | - Attributes()          # List of attributes of a footprint
+  | - Model()               # 3D Model
+  | - DrillDefinition()     # Drill mark of a footprint pad
+  | - PadOptions()          # Settings for custom pads
+  | - Pad()                 # A footprint pad
+  | - Footprint()           # Footprint files (.kicad_mod)
+  |
   + libraries.py
   | - Library()             # Library table entry
   | - LibTable()            # Library table file (fp-lib-table or sym-lib-table)

diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=42"]
+build-backend = "setuptools.build_meta"
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,27 @@
+[metadata]
+name = kiutils
+version = 1.1.0
+author = Marvin Mager
+author_email = [email protected]
+description = Simple and SCM-friendly KiCad file parser for KiCad 6.0 and up
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/mvnmgrx/kiutils
+project_urls =
+    Bug Tracker = https://github.com/mvnmgrx/kiutils/issues
+classifiers =
+    Programming Language :: Python :: 3.10
+    License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+    Operating System :: OS Independent
+    Development Status :: 5 - Production/Stable
+    Natural Language :: English
+    Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
+
+[options]
+package_dir =
+    = src
+packages = kiutils, kiutils.items, kiutils.utils
+python_requires = >=3.10
+
+[options.packages.find]
+where = src
diff --git a/kiutils/board.py → src/kiutils/board.py b/kiutils/board.py → src/kiutils/board.py
diff --git a/kiutils/footprint.py → src/kiutils/footprint.py b/kiutils/footprint.py → src/kiutils/footprint.py
diff --git a/kiutils/items/brditems.py → src/kiutils/items/brditems.py b/kiutils/items/brditems.py → src/kiutils/items/brditems.py
diff --git a/kiutils/items/common.py → src/kiutils/items/common.py b/kiutils/items/common.py → src/kiutils/items/common.py
diff --git a/kiutils/items/dimensions.py → src/kiutils/items/dimensions.py b/kiutils/items/dimensions.py → src/kiutils/items/dimensions.py
diff --git a/kiutils/items/fpitems.py → src/kiutils/items/fpitems.py b/kiutils/items/fpitems.py → src/kiutils/items/fpitems.py
diff --git a/kiutils/items/gritems.py → src/kiutils/items/gritems.py b/kiutils/items/gritems.py → src/kiutils/items/gritems.py
diff --git a/kiutils/items/schitems.py → src/kiutils/items/schitems.py b/kiutils/items/schitems.py → src/kiutils/items/schitems.py
diff --git a/kiutils/items/syitems.py → src/kiutils/items/syitems.py b/kiutils/items/syitems.py → src/kiutils/items/syitems.py
diff --git a/kiutils/items/zones.py → src/kiutils/items/zones.py b/kiutils/items/zones.py → src/kiutils/items/zones.py
diff --git a/kiutils/libraries.py → src/kiutils/libraries.py b/kiutils/libraries.py → src/kiutils/libraries.py
diff --git a/kiutils/schematic.py → src/kiutils/schematic.py b/kiutils/schematic.py → src/kiutils/schematic.py
diff --git a/kiutils/symbol.py → src/kiutils/symbol.py b/kiutils/symbol.py → src/kiutils/symbol.py
diff --git a/kiutils/utils/sexpr.py → src/kiutils/utils/sexpr.py b/kiutils/utils/sexpr.py → src/kiutils/utils/sexpr.py
diff --git a/kiutils/utils/strings.py → src/kiutils/utils/strings.py b/kiutils/utils/strings.py → src/kiutils/utils/strings.py