Skip to main content

Python binding for the Archicad JSON command interface

Project description

Archicad Python Interface

Project Description

This is the official Python binding for the Archicad JSON command interface.

This package provides a convenient way to write simple scripts to support your Archicad workflow, e.g. by automating repetitive tasks.

The set of available commands will increase with each release.

Requirements

  • Archicad 24 beta 3 or later.
  • Python 3.7 or later (Tcl/Tk is recommended)

Getting started

  • Install the package with pip
  • Optional: Enable the experimental Python palette in Archicad
  • Run your own scripts either from the command line or directly from ARCHICAD

Documentations

Release notes

29.3000

Here's an overview of the changes included in this release:

  • PropertyTypes
    • A new property called NormalPropertyValue has been added.
  • Types
    • A new enum value called All has been added to ElementTypes enum.
  • GetElementsRelatedToZones
    • The elementTypes command parameter is now required.
      • In cases where elementTypes was not used previously, use it with the newly added All value.
  • GetPropertyValuesOfElements
    • A new parameter called onlySupportedTypes has been added.
      • Optional parameter. When it is set to true, only elements with types that are supported by any other JSON API command will be returned.

28.3000

Here's an overview of the changes included in this release:

  • GetSelectedElements
    • A new parameter called onlySupportedTypes has been added.
      • When set to true, only elements with types supported by other JSON API commands will be returned.
  • GetAttributesIndices
    • A new function that provides requested indices and GUIDs for given attributes.
  • New Attribute related classes were introduced:
    1. AttributeIndexAndGuid
    2. AttributeIndexAndGuidWrapperItem
    3. AttributeIndexAndGuidOrError

27.3000

This release focuses primarily on maintenance, ensuring continued support for our users.

Here's an overview of the changes included in this release:

  • New Attribute related classes were introduced and some former classes were removed.
  • CreateAttributeFolders uses a list of AttributeFolderCreationParameters instead of AttributeFolders.
  • DeleteAttributeFolders uses AttributeFolderIds instead of AttributeFolders.
  • GetAttributeFolder and GetAttributeFolderContent functions are removed.
  • GetAttributeFolders uses AttributeFolders instead of DetailedAttributeFolders.
  • MoveAttributesAndFolders uses AttributeFolderIds parameters instead of the AttributeFolders.
  • RenameAttributeFolder was renamed to RenameAttributeFolders and uses AttributeFolderRenameParameters instead of the two previous parameters.

26.3000

  • Preparation for Archicad 26 release.
  • More navigator item types are handled
  • New attribute-related commands (folder handling) are introduced
  • Property handling: return info on property default values
  • Removed those attribute types which are not attributes in Archicad reality
  • Classification systems are introduced
  • Property groups are now available
  • Selected elements' identifiers can be queried

25.3000

  • More properties became available. For example, the dynamic enum-typed built-in properties (like Structural Function, Position and Renovation Status) are available from AC25. Those can be retrieved and modified.

25.2255

  • ExecuteAddOnCommand and IsAddOnCommandAvailable commands require command namespace instead of developerId and localId.

25.1100

  • Preparation for ARCHICAD 25 release.
  • New commands were introduced.

25.326

  • Preparation for Archicad 25 release.
  • New commands were introduced.

24.3000

  • An unexpected Runtime Error is fixed.

24.2310b3

  • Beta release. Compatible with the official Archicad beta 3.
  • Doesn't compatible with earlier (preview) versions.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

archicad-29.3000.tar.gz (239.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

archicad-29.3000-py3-none-any.whl (231.9 kB view details)

Uploaded Python 3

File details

Details for the file archicad-29.3000.tar.gz.

File metadata

  • Download URL: archicad-29.3000.tar.gz
  • Upload date:
  • Size: 239.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.2

File hashes

Hashes for archicad-29.3000.tar.gz
Algorithm Hash digest
SHA256 9424cc3128b3d60e8edb0021823377bbfaeffdcea9b1c1ba0160d17ed6f75514
MD5 b708ada73f68f8d99c456a2236b43794
BLAKE2b-256 2f2f197986c9318caf8e751db2e3d36f03bd8ea36146dec8764d507e4200eb68

See more details on using hashes here.

File details

Details for the file archicad-29.3000-py3-none-any.whl.

File metadata

  • Download URL: archicad-29.3000-py3-none-any.whl
  • Upload date:
  • Size: 231.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.2

File hashes

Hashes for archicad-29.3000-py3-none-any.whl
Algorithm Hash digest
SHA256 d145dbaab449158370b1d786294057592f844460e2552bb64c80bd30f9a1d70c
MD5 424f7105bc2bb7ee1155a1ba07f0443b
BLAKE2b-256 94e961ff87eaee30a210b73c5d111b35404a81f34df628b11e2f00fdcc02ed65

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page