# 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
* [Reference Manual](https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html)
* [Documentation of Archicad's new JSON interface](https://archicadapi.graphisoft.com/JSONInterfaceDocumentation/#Introduction)
* [Official website](https://graphisoft.com/downloads/python)
## Release notes
### 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.
Raw data
{
"_id": null,
"home_page": "https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html",
"name": "archicad",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Graphisoft SE",
"author_email": "archicadapi@graphisoft.com",
"download_url": "https://files.pythonhosted.org/packages/ad/58/ba4ee49b3aab5987bf0b87c2de170f10335a510722675a8d7438b51cabbe/archicad-28.3000.tar.gz",
"platform": null,
"description": "# Archicad Python Interface\r\n\r\n## Project Description\r\n\r\nThis is the official Python binding for the Archicad JSON command interface.\r\n\r\nThis package provides a convenient way to write simple scripts to support your Archicad workflow, e.g. by automating repetitive tasks.\r\n\r\nThe set of available commands will increase with each release.\r\n\r\n## Requirements\r\n\r\n* Archicad 24 beta 3 or later.\r\n* Python 3.7 or later (Tcl/Tk is recommended)\r\n\r\n## Getting started\r\n\r\n* Install the package with pip\r\n* *Optional: Enable the experimental Python palette in Archicad*\r\n* Run your own scripts either from the command line or directly from ARCHICAD\r\n\r\n### Documentations\r\n\r\n* [Reference Manual](https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html)\r\n* [Documentation of Archicad's new JSON interface](https://archicadapi.graphisoft.com/JSONInterfaceDocumentation/#Introduction)\r\n* [Official website](https://graphisoft.com/downloads/python)\r\n\r\n## Release notes\r\n\r\n### 28.3000\r\n\r\nHere's an overview of the changes included in this release:\r\n* GetSelectedElements\r\n - A new parameter called `onlySupportedTypes` has been added.\r\n - When set to `true`, only elements with types supported by other JSON API commands will be returned.\r\n* GetAttributesIndices\r\n - A new function that provides requested indices and GUIDs for given attributes.\r\n* New Attribute related classes were introduced:\r\n 1. `AttributeIndexAndGuid`\r\n 2. `AttributeIndexAndGuidWrapperItem`\r\n 3. `AttributeIndexAndGuidOrError`\r\n\r\n### 27.3000\r\n\r\nThis release focuses primarily on maintenance, ensuring continued support for our users.\r\n\r\nHere's an overview of the changes included in this release:\r\n* New Attribute related classes were introduced and some former classes were removed.\r\n* CreateAttributeFolders uses a list of AttributeFolderCreationParameters instead of AttributeFolders.\r\n* DeleteAttributeFolders uses AttributeFolderIds instead of AttributeFolders.\r\n* GetAttributeFolder and GetAttributeFolderContent functions are removed.\r\n* GetAttributeFolders uses AttributeFolders instead of DetailedAttributeFolders.\r\n* MoveAttributesAndFolders uses AttributeFolderIds parameters instead of the AttributeFolders.\r\n* RenameAttributeFolder was renamed to RenameAttributeFolders and uses AttributeFolderRenameParameters instead of the two previous parameters.\r\n\r\n### 26.3000\r\n\r\n* Preparation for Archicad 26 release.\r\n* More navigator item types are handled\r\n* New attribute-related commands (folder handling) are introduced\r\n* Property handling: return info on property default values\r\n* Removed those attribute types which are not attributes in Archicad reality\r\n* Classification systems are introduced\r\n* Property groups are now available\r\n* Selected elements' identifiers can be queried\r\n\r\n### 25.3000\r\n\r\n* 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.\r\n\r\n### 25.2255\r\n\r\n* ExecuteAddOnCommand and IsAddOnCommandAvailable commands require command namespace instead of developerId and localId.\r\n\r\n### 25.1100\r\n\r\n* Preparation for ARCHICAD 25 release.\r\n* New commands were introduced.\r\n\r\n### 25.326\r\n\r\n* Preparation for Archicad 25 release.\r\n* New commands were introduced.\r\n\r\n### 24.3000\r\n\r\n* An unexpected Runtime Error is fixed.\r\n\r\n### 24.2310b3\r\n\r\n* Beta release. Compatible with the official Archicad beta 3.\r\n* Doesn't compatible with earlier (preview) versions.\r\n",
"bugtrack_url": null,
"license": "Apache",
"summary": "Python binding for the Archicad JSON command interface",
"version": "28.3000",
"project_urls": {
"Homepage": "https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a2ea6af0600441566e794c4acac76d71a0a99fa9036d761145848daf528b757b",
"md5": "4624008977e38ff55f50a075158e3bbd",
"sha256": "7fabfb9b6cf087df4b73bf422b8a765df4a65bde3334962c8745345ffa703e8f"
},
"downloads": -1,
"filename": "archicad-28.3000-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4624008977e38ff55f50a075158e3bbd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 197201,
"upload_time": "2024-10-03T13:21:17",
"upload_time_iso_8601": "2024-10-03T13:21:17.104605Z",
"url": "https://files.pythonhosted.org/packages/a2/ea/6af0600441566e794c4acac76d71a0a99fa9036d761145848daf528b757b/archicad-28.3000-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ad58ba4ee49b3aab5987bf0b87c2de170f10335a510722675a8d7438b51cabbe",
"md5": "06157abc9315a1780178d7b95dc6c1d0",
"sha256": "788a8d00cdf842d0c94b8f492d5a6b3021ea071ef080ea6e75161fbeb7418f68"
},
"downloads": -1,
"filename": "archicad-28.3000.tar.gz",
"has_sig": false,
"md5_digest": "06157abc9315a1780178d7b95dc6c1d0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 206041,
"upload_time": "2024-10-03T13:21:18",
"upload_time_iso_8601": "2024-10-03T13:21:18.724927Z",
"url": "https://files.pythonhosted.org/packages/ad/58/ba4ee49b3aab5987bf0b87c2de170f10335a510722675a8d7438b51cabbe/archicad-28.3000.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-03 13:21:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "archicad"
}
JSON