jitx 4.0.0__tar.gz

jitx-4.0.0/.github/workflows/build.yaml

@@ -0,0 +1,44 @@
+
+name: Build
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+    branches:
+      - main
+      - dev
+  pull_request:
+    branches:
+      - main
+      - dev
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-24.04
+
+    permissions:
+      contents: write     # to be able to check out repos and generate app tokens
+      actions: write      # to be able to trigger other workflows
+
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13", "3.14"]
+      fail-fast: false
+
+    steps:
+
+      - name: Build, Test, and Deploy
+        uses: jitx-inc/pybuild-action@v1
+        with:
+           python-version: "${{ matrix.python-version }}"
+           run-publish: true
+           hatch-index-user: ${{ vars.HATCH_INDEX_USER }}
+           hatch-index-auth: ${{ secrets.HATCH_INDEX_AUTH }}
+           notify-slack: true
+           slack-token: ${{ secrets.SLACK_TOKEN }}
+           github-user: ${{ github.actor }}
+           githubapp-id: ${{ vars.GITHUBAPP_ID }}
+           githubapp-private-key: ${{ secrets.GITHUBAPP_PRIVATE_KEY }}

jitx-4.0.0/.github/workflows/release.yaml

@@ -0,0 +1,49 @@
+
+name: Publish to PyPI
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish:
+    name: Publish ${{ github.ref_name }} to PyPI
+    runs-on: ubuntu-24.04
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/jitxcore
+
+    permissions:
+      contents: read   # for reading content from a repo
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+
+    steps:
+
+      - name: Ensure valid tag
+        if: (! github.ref_type == 'tag') || (! startsWith(github.ref_name, 'v')) || contains(github.ref_name, '.dev')
+        shell: bash
+        run: |
+          echo "Invalid tag for publishing: ${{ github.ref_name }}"
+          exit -1
+
+      - name: Fetch Release
+        uses: robinraju/release-downloader@v1
+        with:
+          repository: ${{ github.repository }}
+          tag: ${{ github.ref_name }}
+          fileName: '*'
+          out-file-path: dist/
+          extract: false
+
+      - name: List artifact files
+        shell: bash
+        run: |
+            ls -la dist/ || true
+            rm -f dist/requirements.txt
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: "https://upload.pypi.org/legacy/"
+          packages-dir: dist/
+

jitx-4.0.0/.gitignore

@@ -0,0 +1,5 @@
+.*
+!.github
+__pycache__
+dist
+jitx_*

jitx-4.0.0/PKG-INFO

@@ -0,0 +1,31 @@
+Metadata-Version: 2.4
+Name: jitx
+Version: 4.0.0
+Summary: Design complex circuit boards by writing simple code and streamline your existing design process
+Project-URL: Homepage, https://jitx.com
+Project-URL: Documentation, https://docs.jitx.com
+Author: JITX
+Maintainer: JITX
+Keywords: circuit board,jitx,pcb
+Classifier: Development Status :: 1 - Planning
+Classifier: Framework :: Hatch
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows :: Windows 10
+Classifier: Operating System :: Microsoft :: Windows :: Windows 11
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: jitxcore==4.0.0
+Requires-Dist: packaging<26.0,>=25.0
+Requires-Dist: pint==0.24.4
+Requires-Dist: shapely<3.0,>=2.1.0
+Requires-Dist: websockets==15.0.1

jitx-4.0.0/build.log

@@ -0,0 +1 @@
+──────────────────────────────────── sdist ─────────────────────────────────────

jitx-4.0.0/docs/Makefile

@@ -0,0 +1,55 @@
+# JITX makefile for jitx Sphinx documentation
+#
+
+SHELL := /bin/bash
+
+# You can set these variables from the command line, and also
+# from the environment for the first three.
+PIPOPTS       ?= --extra-index-url "https://pypi.jitx.com/jitx/main/+simple"
+SPHINXOPTS    ?= --jobs 1 --write-all --fresh-env --warning-file build.out
+SPHINXAPIDOC  ?= sphinx-apidoc
+SPHINXBUILD   ?= sphinx-build
+PROJNAME      := api
+SOURCEDIR     := source
+BUILDDIR      := build
+PYSRCDIR      := ../src/jitx
+VER           := $(shell hatch version)
+ARCHIVENAME   := docs-jitx-$(PROJNAME)-$(VER).tar.bz2
+
+.PHONY: all
+all: html archive
+
+# create python venv
+.venv: requirements.txt
+	python -m venv .venv \
+	  && source .venv/bin/activate \
+	  && pip install $(PIPOPTS) -r requirements.txt \
+	  && touch .venv
+
+# generate docs from python source
+.PHONY: apidoc
+apidoc: .venv
+	source .venv/bin/activate \
+	  && $(SPHINXAPIDOC)  \
+	    -o "source/$(PROJNAME)"  \
+	    "../src/$(PYSRCDIR)"  \
+	    --maxdepth 4  \
+	    --separate  \
+	    --implicit-namespaces  \
+	    --doc-project "JITX $(PROJNAME) Documentation"
+
+# convert to html
+.PHONY: html
+html: .venv apidoc
+	source .venv/bin/activate \
+	  && $(SPHINXBUILD) --builder html $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)"
+
+# create archive
+.PHONY: archive
+archive:
+	tar jcf "$(ARCHIVENAME)" "$(SOURCEDIR)" "$(BUILDDIR)"
+
+# clean up
+.PHONY: clean
+clean:
+	rm -rf .venv "source/api" "$(BUILDDIR)" build.out "$(ARCHIVENAME)"

jitx-4.0.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

jitx-4.0.0/docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx
+sphinx_autodoc_typehints
+pint

jitx-4.0.0/docs/source/conf.py

@@ -0,0 +1,61 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# Add jitx source to import path
+import os
+import sys
+from pathlib import Path
+from sphinx.ext import autodoc
+
+os.environ["JITX_PASSIVE_INSTANTIATION"] = "1"
+sys.path.insert(0, str(Path("..", "..", "src").resolve()))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "jitx"
+copyright = "2025, JITX Inc"  # noqa: A001
+author = "JITX Inc"
+version = "0.1"
+release = "0.1.0dev1"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+needs_sphinx = "8.1"
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.coverage",
+    "sphinx.ext.doctest",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.napoleon",
+    "sphinx_autodoc_typehints",
+]
+templates_path = ["_templates"]
+exclude_patterns = []
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "alabaster"
+html_static_path = ["_static"]
+
+# -- Don't show "Bases: object" in api docs ----------------------------------
+# https://stackoverflow.com/questions/46279030/how-can-i-prevent-sphinx-from-listing-object-as-a-base-class
+
+
+class MockedClassDocumenter(autodoc.ClassDocumenter):
+    def add_line(self, line: str, source: str, *lineno: int) -> None:
+        if line == "   Bases: :py:class:`object`":
+            return
+        super().add_line(line, source, *lineno)
+
+
+autodoc.ClassDocumenter = MockedClassDocumenter
+
+autodoc_mock_imports = ["websockets", "shapely"]
+autodoc_default_options = {
+    "member-order": "bysource",  # 'alphabetical', 'groupwise', or 'bysource'
+}

jitx-4.0.0/docs/source/index.rst

@@ -0,0 +1,14 @@
+.. py-jitx documentation master file, created by
+   sphinx-quickstart on Thu Mar 20 18:52:41 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+py-jitx documentation
+=====================
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Contents:
+
+   api/modules
+

jitx-4.0.0/hooks/pre-commit

@@ -0,0 +1,20 @@
+#!/bin/bash -e
+
+# Redirect output to stderr.
+exec 1>&2
+
+root=$(git rev-parse --show-toplevel)
+pyfiles=$(git diff --cached --name-only --diff-filter=AM | awk '/\.py$/')
+
+if [ -n "$pyfiles" ]; then
+  ruff check --quiet $pyfiles
+  ruff format --silent --diff $pyfiles
+fi
+
+(
+  cd $root
+  python -m unittest discover
+)
+
+# If there are whitespace errors, print the offending file names and fail.
+exec git diff-index --check --cached HEAD --

jitx-4.0.0/lint.log

@@ -0,0 +1,4 @@
+cmd [1] | ruff check .
+All checks passed!
+cmd [2] | ruff format --check --diff .
+91 files already formatted

jitx-4.0.0/pyproject.toml

@@ -0,0 +1,121 @@
+[build-system]
+requires = [
+  "hatchling>=1.27.0,<2.0",
+  "hatch-vcs>=0.4.0,<0.5.0",
+  "ruff==0.11.2",
+  "pyright>=1.1.398,<1.2.0",
+]
+build-backend = "hatchling.build"
+
+[tool.hatch.envs.default]
+path = ".hatch/envs/default"
+
+[project]
+name = "jitx"
+dynamic = ["version"]
+dependencies = [
+  "jitxcore==4.0.0",
+  "websockets==15.0.1",
+  "shapely>=2.1.0,<3.0",
+  "Pint==0.24.4",
+  "packaging>=25.0,<26.0",
+]
+requires-python = ">=3.12"
+authors = [
+  {name = "JITX"}
+]
+maintainers = [
+  {name = "JITX"}
+]
+description = "Design complex circuit boards by writing simple code and streamline your existing design process"
+keywords = ["jitx", "pcb", "circuit board"]
+classifiers = [
+  "Development Status :: 1 - Planning",
+  "Framework :: Hatch",
+  "Framework :: Pytest",
+  "Intended Audience :: Developers",
+  "License :: Other/Proprietary License",
+  "Operating System :: MacOS :: MacOS X",
+  "Operating System :: Microsoft :: Windows :: Windows 10",
+  "Operating System :: Microsoft :: Windows :: Windows 11",
+  "Operating System :: POSIX :: Linux",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python",
+  "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://jitx.com"
+Documentation = "https://docs.jitx.com"
+
+
+[tool]
+
+[tool.hatch.envs.default.env-vars]
+PIP_INDEX_URL = "https://pypi.jitx.com/jitx/main/+simple"
+
+[tool.hatch.envs.hatch-test.env-vars]
+PIP_INDEX_URL = "https://pypi.jitx.com/jitx/main/+simple"
+
+# tests: run "hatch test --cover"
+[tool.hatch.envs.test]
+dependencies = [
+  "coverage[toml]",
+  "pytest",
+  "pytest-cov",
+]
+
+[tool.hatch.envs.hatch-test]
+randomize = true
+parallel = false
+installer = "pip"
+extra-args = ["-vv"]
+
+[[tool.hatch.envs.test.matrix]]
+python = ["3.12", "3.13", "3.14"]
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.version]
+source = "vcs"
+fallback-version = "0.0.0+undefined"
+
+# formatting: run "hatch fmt --check"
+[tool.hatch.envs.hatch-static-analysis]
+dependencies = ["ruff==0.11.2"]
+config-path = "none"  # don't use hatch defaults
+
+[tool.ruff]
+line-length = 88
+indent-width = 4
+target-version = "py312"
+
+[tool.ruff.lint]
+# To enable:
+# UP, TC
+select = ["E", "F", "W", "A", "B", "C", "UP"]
+# E501 line too long - let ruff format handle that
+# A002 variable shadowing built-in (id, min, max)
+# A005 builtin module shadowing (false positive)
+# C901 mccabe complexity check, limits to 10
+ignore = ["E501", "A005", "C901", "A002"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+# pyright: run "hatch run types:check"
+[tool.hatch.envs.types]
+extra-dependencies = [
+  "pyright>=1.1.0",
+  "sphinx>=8.1.0,<9.0",
+]
+
+[tool.hatch.envs.types.scripts]
+check = "pyright ."
+stats = "pyright --stats ."

jitx-4.0.0/pyright.json

@@ -0,0 +1,11 @@
+{
+  "include": [
+    "src"
+  ],
+
+  "exclude": [
+    "**/__pycache__"
+  ],
+
+  "pythonVersion": "3.12"
+}

jitx-4.0.0/src/jitx/__init__.py

@@ -0,0 +1,212 @@
+"""
+JITX Python API
+===============
+
+The JITX Python API is a set of classes that can be used to build a design in
+Python. The core principle of the API is that, when run, your code constructs
+an object tree that is then inspected. This means that creating an object and
+attaching them to other objects is what drives the construction of the design,
+and not function calls. The root of the tree is an instance of a
+:py:class:`~jitx.design.Design` subclass. The JITX runtime will inspect your
+project looking for Design subclasses which are then instantiated on request.
+
+The inspection mechanism will traverse lists, tuples, and dictionaries, as
+well, thus objects can be added to arrays and dictionaries as needed when
+building the object tree.
+
+The API is designed to be as simple as possible, and to be as close to Python
+as possible. The API is designed to be used with a Python language server, such
+as PyLance/pyright, to provide autocompletion and type checking.
+
+.. note::
+
+    There are a few mechanisms designed to make API usage cleaner by allowing
+    instantiated objects as class attributes, but there are caveats to be aware
+    of when doing more involved logic, and when in doubt, all logic can also be
+    placed in the initializer of the class. Runtime errors involving an
+    unexpected "Instantiable" object is indicative of this type of error.
+"""
+
+from .anchor import Anchor as Anchor
+from .board import Board as Board
+from .circuit import Circuit as Circuit, CurrentCircuit
+from .component import Component as Component, CurrentComponent
+from .constraints import (
+    IsBoardEdge as IsBoardEdge,
+    IsCopper as IsCopper,
+    IsHole as IsHole,
+    IsNeckdown as IsNeckdown,
+    IsPad as IsPad,
+    IsPour as IsPour,
+    IsThroughHole as IsThroughHole,
+    IsTrace as IsTrace,
+    IsVia as IsVia,
+    SquareViaStitchGrid as SquareViaStitchGrid,
+    Tag as Tag,
+    Tags as Tags,
+    TriangularViaStitchGrid as TriangularViaStitchGrid,
+    ViaFencePattern as ViaFencePattern,
+    design_constraint as design_constraint,
+)
+from .container import Composite as Composite, Container as Container
+from .context import ContextProperty
+from .copper import Copper as Copper, Pour as Pour
+from .design import Design as Design, DesignContext
+from .error import UserCodeException as UserCodeException
+from .feature import (
+    Courtyard as Courtyard,
+    Custom as Custom,
+    Cutout as Cutout,
+    Finish as Finish,
+    Glue as Glue,
+    KeepOut as KeepOut,
+    Paste as Paste,
+    Silkscreen as Silkscreen,
+    Soldermask as Soldermask,
+)
+from .inspect import decompose as decompose, extract as extract, visit as visit
+from .landpattern import (
+    Landpattern as Landpattern,
+    Pad as Pad,
+    PadMapping as PadMapping,
+)
+from .layerindex import LayerSet as LayerSet, Side as Side
+from .net import (
+    DiffPair as DiffPair,
+    Net as Net,
+    Port as Port,
+    provide as provide,
+    Provide as Provide,
+)
+from .placement import Placement as Placement, Positionable as Positionable
+from .shapes.composites import capsule as capsule, rectangle as rectangle
+from .shapes.primitive import (
+    Arc as Arc,
+    ArcPolygon as ArcPolygon,
+    ArcPolyline as ArcPolyline,
+    Circle as Circle,
+    Polygon as Polygon,
+    Polyline as Polyline,
+)
+from .substrate import Substrate as Substrate, SubstrateContext
+from .symbol import Pin as Pin, Symbol as Symbol, SymbolMapping as SymbolMapping
+from .toleranced import Toleranced as Toleranced
+from .transform import Point as Point, Transform as Transform
+from .via import Via as Via
+
+# the pattern used above
+#
+# from X import Class as Class
+#
+# is a convention to indicate to language servers that the name should be
+# reexported from the module and offered during autocompletion, as well as not
+# flagged as an unused import.
+
+
+class Current:
+    """
+    Context registry object, where each field is a property that will get
+    the currently registered context value. If no such context is currently
+    active, it will raise an exception. This is purely for convenience, the
+    contexts can be accessed directly.
+
+    The main purpose of this is to allow introspection of the environment. Note
+    that any accessed context value will be part of the memoization key, and
+    thus if the environment changes a memoized element will be reevaluated, and
+    thus use of current circuit or component should be used with care.
+
+    There is already an instance of this class, :py:data:`current`, which can
+    be used directly.
+    """
+
+    design = ContextProperty(DesignContext, lambda x: x.design)
+    "The current design being built"
+    substrate = ContextProperty(SubstrateContext, lambda x: x.substrate)
+    "The substrate of the current design"
+    circuit = ContextProperty(CurrentCircuit, lambda x: x.circuit)
+    "The current circuit being constructed"
+    component = ContextProperty(CurrentComponent, lambda x: x.component)
+    "The current component being constructed"
+
+    def __repr__(self):
+        return "Current"
+
+
+current = Current()
+"""Singleton, the "current" context registry."""
+
+# this can't be autogenerated at runtime, since the typechecker won't know what is
+# actually imported if someone does from jitx import *, thus they need to be
+# listed in the source file; please remember to update this if you add new
+# imports that should be reexported
+
+# grep '^\(from\|   \)' __init__.py | grep -o 'as [^, ]*\(,\|$\)' | sed -e 's/^as \([^,]*\).*$/    "\1",/'
+__all__ = [
+    "current",
+    # list below is generated with the grep command
+    "Anchor",
+    "Board",
+    "Circuit",
+    "Component",
+    "IsBoardEdge",
+    "IsCopper",
+    "IsHole",
+    "IsNeckdown",
+    "IsPad",
+    "IsPour",
+    "IsThroughHole",
+    "IsTrace",
+    "IsVia",
+    "SquareViaStitchGrid",
+    "Tag",
+    "Tags",
+    "TriangularViaStitchGrid",
+    "ViaFencePattern",
+    "design_constraint",
+    "Composite",
+    "Container",
+    "Copper",
+    "Pour",
+    "Design",
+    "UserCodeException",
+    "Courtyard",
+    "Custom",
+    "Cutout",
+    "Finish",
+    "Glue",
+    "KeepOut",
+    "Paste",
+    "Silkscreen",
+    "Soldermask",
+    "decompose",
+    "extract",
+    "visit",
+    "Landpattern",
+    "Pad",
+    "PadMapping",
+    "LayerSet",
+    "Side",
+    "DiffPair",
+    "Net",
+    "Port",
+    "provide",
+    "Provide",
+    "Placement",
+    "Positionable",
+    "capsule",
+    "rectangle",
+    "Arc",
+    "ArcPolygon",
+    "ArcPolyline",
+    "Circle",
+    "Polygon",
+    "Polyline",
+    "Substrate",
+    "Pin",
+    "Symbol",
+    "SymbolMapping",
+    "Toleranced",
+    "Point",
+    "Transform",
+    "Via",
+]