infrasketch 0.1.0__tar.gz

infrasketch-0.1.0/LICENSE

@@ -0,0 +1,29 @@
+MIT License
+
+This license applies to the infrasketch source code only.
+
+It does not apply to the Microsoft Azure Architecture Icons under
+src/infrasketch/data/icons/. Those files remain Microsoft artwork. They may be
+copied, distributed, and displayed only for architecture diagrams, training
+materials, and documentation. Their terms are in NOTICE and in
+src/infrasketch/data/icons/LICENSE.txt.
+
+Copyright (c) 2026 the infrasketch authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

infrasketch-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+recursive-include src/infrasketch/data *.svg *.json *.txt
+include src/infrasketch/py.typed
+include LICENSE
+include NOTICE

infrasketch-0.1.0/NOTICE

@@ -0,0 +1,27 @@
+Third-party artwork
+
+The SVG files in src/infrasketch/data/icons/ are the Microsoft Azure Architecture
+Icons (package Azure_Public_Service_Icons_V25, published November 2026). They
+are not covered by the MIT license that applies to the infrasketch source code.
+A copy of these terms is kept beside the files in
+src/infrasketch/data/icons/LICENSE.txt.
+
+Microsoft permits the use of these icons in architectural diagrams, training
+materials, or documentation. You may copy, distribute, and display the icons
+only for that permitted use, unless Microsoft grants explicit permission for
+something else. Microsoft reserves all other rights.
+
+Permitted:
+
+- Use an icon to show how Azure products work together.
+- Keep the product name near the icon in a diagram.
+- Show the icon as it appears in Azure.
+
+Not permitted:
+
+- Do not crop, flip, rotate, recolor, or otherwise change an icon's shape.
+- Do not use a Microsoft product icon to represent your own product or service.
+- Do not present the icons as MIT, Apache, public-domain, or infrasketch artwork.
+- Do not imply that Microsoft made, sponsors, or endorses this package.
+
+Source and terms: https://learn.microsoft.com/azure/architecture/icons/

infrasketch-0.1.0/PKG-INFO

@@ -0,0 +1,185 @@
+Metadata-Version: 2.4
+Name: infrasketch
+Version: 0.1.0
+Summary: Draw Azure architecture diagrams as SVG with official resource icons. No Graphviz.
+Author: infrasketch
+License-Expression: MIT AND LicenseRef-Microsoft-Azure-Architecture-Icons
+Keywords: azure,architecture,diagram,svg,icons
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+License-File: src/infrasketch/data/icons/LICENSE.txt
+Dynamic: license-file
+
+# infrasketch
+
+Draw Azure architecture diagrams as SVG. The package uses the official Azure
+resource icons and lays the diagram out itself, so Graphviz is not required.
+
+```python
+from infrasketch import Diagram, FrontDoor, FunctionApp, Redis, ResourceGroup
+
+with Diagram("Orders", "orders.svg"):
+    with ResourceGroup("rg-app"):
+        web = FrontDoor("Frontend")
+        api = FunctionApp("API")
+        cache = Redis("Sessions")
+    web >> api >> cache
+```
+
+That writes `orders.svg` when the block ends. The icon says which Azure
+service it is. The label is your name for that piece of the system, and the
+caption under it is the service name.
+
+## Install
+
+```bash
+pip install infrasketch
+```
+
+## Documentation
+
+The guide and the searchable icon browser are published at
+[antsticky.github.io/infrasketch](https://antsticky.github.io/infrasketch/).
+
+## Draw a diagram
+
+Resources only exist inside a diagram. Groups are context managers too, so the
+indentation is the architecture:
+
+```python
+from infrasketch import (
+    Diagram, Edge, Https, Private,
+    ResourceGroup, VNet, Subnet, PrivateNetwork,
+    Users, FrontDoor, StaticWebApp, AppService, Redis, SQLDatabase, KeyVault,
+)
+
+with Diagram("Web, API, and Redis", "platform.svg", subtitle="Production · West Europe"):
+    customers = Users("Customers")
+    with ResourceGroup("rg-edge"):
+        door = FrontDoor("Entry")
+    with ResourceGroup("rg-app"):
+        with VNet("vnet-app"):
+            with Subnet("snet-web"):
+                web = StaticWebApp("Storefront")
+            with Subnet("snet-api"):
+                api = AppService("Orders API")
+            with PrivateNetwork("data"):
+                cache = Redis("Sessions")
+                database = SQLDatabase("Orders")
+                vault = KeyVault("Secrets")
+
+    customers >> Https() >> door >> web >> api
+    api >> [cache, database]
+    api >> Private("secrets") >> vault
+```
+
+`direction="TB"` flows top to bottom. `spacing` is `"compact"`, `"regular"`,
+or `"relaxed"`. Pass `autosave=False` when you want the SVG string yourself:
+
+```python
+with Diagram("Orders", autosave=False) as diagram:
+    ...
+svg = diagram.svg()
+diagram.save("orders.svg")
+```
+
+## Connectors
+
+| Code | Result |
+| --- | --- |
+| `a >> b` | Arrow from a to b |
+| `a >> [b, c]` | Arrow from a to each target |
+| `[a, b] >> c` | Arrow from each source to c |
+| `a << b` | Arrow pointing back at a |
+| `a - b` | Line with no arrowhead |
+| `a >> Edge("SQL", style="dashed") >> b` | Labelled connector |
+| `a >> Https() >> b` | Azure-blue HTTPS |
+| `a >> Async("enqueue") >> b` | Dashed queue or event |
+| `a >> Private() >> b` | Dashed Private Link |
+
+`style` is `"solid"`, `"dashed"`, or `"dotted"`. `color` is a hex color such
+as `"#0078D4"`.
+
+## Boundaries
+
+| Group | Use it for |
+| --- | --- |
+| `Subscription("sub")` | A subscription |
+| `ResourceGroup("rg-app")` | A resource group |
+| `Region("West Europe")` | A region |
+| `VNet("vnet-app")` | A virtual network |
+| `Subnet("snet-api")` | A subnet |
+| `PrivateNetwork("data")` | Private endpoints or Private Link |
+| `Group("Workers")` | Anything else |
+
+Inside a boundary, connected resources flow in the diagram direction.
+Resources at the same step stack, which is what you want for a cache beside
+its database. `arrange="row"` forces a single row, `arrange="column"` a
+single column, and `arrange="grid"` with `columns=3` a grid.
+
+## Finding an icon
+
+Common resources have short names: `FunctionApp`, `ContainerApp`, `ACR`,
+`AKS`, `Redis`, `ManagedRedis`, `SQLDatabase`, `CosmosDB`, `PostgreSQL`,
+`StorageAccount`, `KeyVault`, `FrontDoor`, `ApplicationGateway`,
+`ServiceBus`, `StaticWebApp`.
+
+Everything in the Azure icon set is included. Search when you need the rest:
+
+```bash
+python -m infrasketch search private endpoint
+python -m infrasketch search container registry
+python -m infrasketch categories
+```
+
+```python
+from infrasketch import search
+
+for hit in search("cosmos"):
+    print(hit.import_line)
+```
+
+```python
+from infrasketch.networking import Bastions
+```
+
+`FunctionApp("Orders")` labels the box "Orders" and captions it "Function App".
+`FunctionApp()` uses the service name as the only label. `caption=False` hides
+the caption.
+
+A resource with no icon draws a neutral placeholder. Pass `icon="path/to.svg"`
+to use your own artwork. Azure icons are never recoloured or stretched.
+
+## Examples
+
+| Script | What it shows |
+| --- | --- |
+| `examples/web_api_redis.py` | Front Door, static web app, API, Redis, SQL, Key Vault |
+| `examples/container_apps.py` | ACR, Container Apps, private endpoints |
+| `examples/functions_events.py` | API Management, functions, Service Bus, Cosmos DB, storage |
+| `examples/aks_platform.py` | AKS, ACR, firewall, PostgreSQL, managed Redis |
+
+![Web, API, and Redis](examples/out/web-api-redis.svg)
+
+![Container Apps](examples/out/container-apps.svg)
+
+## License
+
+The package license expression is
+`MIT AND LicenseRef-Microsoft-Azure-Architecture-Icons`.
+
+The Python code is MIT. See `LICENSE`.
+
+The SVG files in `src/infrasketch/data/icons` are Microsoft Azure Architecture
+Icons (V25). They are not MIT. Their identifier is
+`LicenseRef-Microsoft-Azure-Architecture-Icons`. Microsoft allows them in architecture diagrams,
+training materials, and documentation only. Do not crop, flip, rotate, recolor,
+or reshape them, and do not use them as a logo or to represent your own
+product. The terms travel with the files in `NOTICE` and
+`src/infrasketch/data/icons/LICENSE.txt`.

infrasketch-0.1.0/README.md

@@ -0,0 +1,167 @@
+# infrasketch
+
+Draw Azure architecture diagrams as SVG. The package uses the official Azure
+resource icons and lays the diagram out itself, so Graphviz is not required.
+
+```python
+from infrasketch import Diagram, FrontDoor, FunctionApp, Redis, ResourceGroup
+
+with Diagram("Orders", "orders.svg"):
+    with ResourceGroup("rg-app"):
+        web = FrontDoor("Frontend")
+        api = FunctionApp("API")
+        cache = Redis("Sessions")
+    web >> api >> cache
+```
+
+That writes `orders.svg` when the block ends. The icon says which Azure
+service it is. The label is your name for that piece of the system, and the
+caption under it is the service name.
+
+## Install
+
+```bash
+pip install infrasketch
+```
+
+## Documentation
+
+The guide and the searchable icon browser are published at
+[antsticky.github.io/infrasketch](https://antsticky.github.io/infrasketch/).
+
+## Draw a diagram
+
+Resources only exist inside a diagram. Groups are context managers too, so the
+indentation is the architecture:
+
+```python
+from infrasketch import (
+    Diagram, Edge, Https, Private,
+    ResourceGroup, VNet, Subnet, PrivateNetwork,
+    Users, FrontDoor, StaticWebApp, AppService, Redis, SQLDatabase, KeyVault,
+)
+
+with Diagram("Web, API, and Redis", "platform.svg", subtitle="Production · West Europe"):
+    customers = Users("Customers")
+    with ResourceGroup("rg-edge"):
+        door = FrontDoor("Entry")
+    with ResourceGroup("rg-app"):
+        with VNet("vnet-app"):
+            with Subnet("snet-web"):
+                web = StaticWebApp("Storefront")
+            with Subnet("snet-api"):
+                api = AppService("Orders API")
+            with PrivateNetwork("data"):
+                cache = Redis("Sessions")
+                database = SQLDatabase("Orders")
+                vault = KeyVault("Secrets")
+
+    customers >> Https() >> door >> web >> api
+    api >> [cache, database]
+    api >> Private("secrets") >> vault
+```
+
+`direction="TB"` flows top to bottom. `spacing` is `"compact"`, `"regular"`,
+or `"relaxed"`. Pass `autosave=False` when you want the SVG string yourself:
+
+```python
+with Diagram("Orders", autosave=False) as diagram:
+    ...
+svg = diagram.svg()
+diagram.save("orders.svg")
+```
+
+## Connectors
+
+| Code | Result |
+| --- | --- |
+| `a >> b` | Arrow from a to b |
+| `a >> [b, c]` | Arrow from a to each target |
+| `[a, b] >> c` | Arrow from each source to c |
+| `a << b` | Arrow pointing back at a |
+| `a - b` | Line with no arrowhead |
+| `a >> Edge("SQL", style="dashed") >> b` | Labelled connector |
+| `a >> Https() >> b` | Azure-blue HTTPS |
+| `a >> Async("enqueue") >> b` | Dashed queue or event |
+| `a >> Private() >> b` | Dashed Private Link |
+
+`style` is `"solid"`, `"dashed"`, or `"dotted"`. `color` is a hex color such
+as `"#0078D4"`.
+
+## Boundaries
+
+| Group | Use it for |
+| --- | --- |
+| `Subscription("sub")` | A subscription |
+| `ResourceGroup("rg-app")` | A resource group |
+| `Region("West Europe")` | A region |
+| `VNet("vnet-app")` | A virtual network |
+| `Subnet("snet-api")` | A subnet |
+| `PrivateNetwork("data")` | Private endpoints or Private Link |
+| `Group("Workers")` | Anything else |
+
+Inside a boundary, connected resources flow in the diagram direction.
+Resources at the same step stack, which is what you want for a cache beside
+its database. `arrange="row"` forces a single row, `arrange="column"` a
+single column, and `arrange="grid"` with `columns=3` a grid.
+
+## Finding an icon
+
+Common resources have short names: `FunctionApp`, `ContainerApp`, `ACR`,
+`AKS`, `Redis`, `ManagedRedis`, `SQLDatabase`, `CosmosDB`, `PostgreSQL`,
+`StorageAccount`, `KeyVault`, `FrontDoor`, `ApplicationGateway`,
+`ServiceBus`, `StaticWebApp`.
+
+Everything in the Azure icon set is included. Search when you need the rest:
+
+```bash
+python -m infrasketch search private endpoint
+python -m infrasketch search container registry
+python -m infrasketch categories
+```
+
+```python
+from infrasketch import search
+
+for hit in search("cosmos"):
+    print(hit.import_line)
+```
+
+```python
+from infrasketch.networking import Bastions
+```
+
+`FunctionApp("Orders")` labels the box "Orders" and captions it "Function App".
+`FunctionApp()` uses the service name as the only label. `caption=False` hides
+the caption.
+
+A resource with no icon draws a neutral placeholder. Pass `icon="path/to.svg"`
+to use your own artwork. Azure icons are never recoloured or stretched.
+
+## Examples
+
+| Script | What it shows |
+| --- | --- |
+| `examples/web_api_redis.py` | Front Door, static web app, API, Redis, SQL, Key Vault |
+| `examples/container_apps.py` | ACR, Container Apps, private endpoints |
+| `examples/functions_events.py` | API Management, functions, Service Bus, Cosmos DB, storage |
+| `examples/aks_platform.py` | AKS, ACR, firewall, PostgreSQL, managed Redis |
+
+![Web, API, and Redis](examples/out/web-api-redis.svg)
+
+![Container Apps](examples/out/container-apps.svg)
+
+## License
+
+The package license expression is
+`MIT AND LicenseRef-Microsoft-Azure-Architecture-Icons`.
+
+The Python code is MIT. See `LICENSE`.
+
+The SVG files in `src/infrasketch/data/icons` are Microsoft Azure Architecture
+Icons (V25). They are not MIT. Their identifier is
+`LicenseRef-Microsoft-Azure-Architecture-Icons`. Microsoft allows them in architecture diagrams,
+training materials, and documentation only. Do not crop, flip, rotate, recolor,
+or reshape them, and do not use them as a logo or to represent your own
+product. The terms travel with the files in `NOTICE` and
+`src/infrasketch/data/icons/LICENSE.txt`.

infrasketch-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "infrasketch"
+version = "0.1.0"
+description = "Draw Azure architecture diagrams as SVG with official resource icons. No Graphviz."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT AND LicenseRef-Microsoft-Azure-Architecture-Icons"
+license-files = [
+    "LICENSE",
+    "NOTICE",
+    "src/infrasketch/data/icons/LICENSE.txt",
+]
+keywords = ["azure", "architecture", "diagram", "svg", "icons"]
+authors = [{ name = "infrasketch" }]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Documentation",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+infrasketch = [
+    "py.typed",
+    "data/catalog.json",
+    "data/icons/LICENSE.txt",
+    "data/icons/*/*.svg",
+]

infrasketch-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

infrasketch-0.1.0/src/infrasketch/__init__.py

@@ -0,0 +1,55 @@
+"""Draw Azure architecture diagrams as SVG, with the official resource icons.
+
+Graphviz is not required. A diagram is a ``with`` block, resources are
+constructed inside it, and ``>>`` draws the arrow::
+
+    from infrasketch import Diagram, FrontDoor, FunctionApp, Redis, ResourceGroup
+
+    with Diagram("Orders", "orders.svg"):
+        with ResourceGroup("rg-app"):
+            web = FrontDoor("Frontend")
+            api = FunctionApp("API")
+            cache = Redis("Sessions")
+        web >> api >> cache
+
+The file is written when the block ends. ``python -m infrasketch search redis``
+finds the class for any other resource.
+
+The source code is MIT. The Azure icons are Microsoft artwork and are not
+covered by that license. See ``NOTICE``.
+"""
+
+from infrasketch.groups import (
+    Cluster,
+    Group,
+    PrivateNetwork,
+    Region,
+    ResourceGroup,
+    Subnet,
+    Subscription,
+    VNet,
+)
+from infrasketch.model import Async, Diagram, Edge, Https, Node, Private
+from infrasketch.search import categories, search
+from infrasketch.shortcuts import *  # noqa: F403
+from infrasketch.shortcuts import __all__ as _resources
+
+__all__ = [
+    "Async",
+    "Cluster",
+    "Diagram",
+    "Edge",
+    "Group",
+    "Https",
+    "Node",
+    "Private",
+    "PrivateNetwork",
+    "Region",
+    "ResourceGroup",
+    "Subnet",
+    "Subscription",
+    "VNet",
+    "categories",
+    "search",
+    *_resources,
+]

infrasketch-0.1.0/src/infrasketch/__main__.py

@@ -0,0 +1,44 @@
+"""``python -m infrasketch search <words>`` prints the import to use."""
+
+from __future__ import annotations
+
+import argparse
+import sys
+
+from infrasketch.search import categories, search
+
+
+def main(argv: list[str] | None = None) -> int:
+    parser = argparse.ArgumentParser(
+        prog="infrasketch",
+        description="Find Azure resource classes and draw architecture diagrams.",
+    )
+    sub = parser.add_subparsers(dest="command")
+
+    find = sub.add_parser("search", help="Find a resource by name")
+    find.add_argument("query", nargs="+", help="Words to match, such as: managed redis")
+
+    listed = sub.add_parser("categories", help="List resource categories")
+    listed.set_defaults(command="categories")
+
+    args = parser.parse_args(argv)
+    if args.command == "search":
+        hits = search(" ".join(args.query))
+        if not hits:
+            print("No matching resources.")
+            return 1
+        for hit in hits:
+            print(hit)
+            print()
+        print(f"{len(hits)} match{'es' if len(hits) != 1 else ''}.")
+        return 0
+    if args.command == "categories":
+        for name in categories():
+            print(name)
+        return 0
+    parser.print_help()
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())