idstool


Nameidstool JSON
Version 0.1.3 PyPI version JSON
download
home_page
SummaryPython Tool to create IDS (Information delivery specification) files
upload_time2024-02-04 10:27:56
maintainer
docs_urlNone
author
requires_python>=3.10
license
keywords ids information delivery specification openbim
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # idstool
 Python Tool to create IDS (Information delivery specification) files for openBIM workflows.

 Currently built on IDS version 0.9.6


# Example

An example on how to use this library to create an IDS:

```python
import idstool as ids

spec1 = ids.Specification(name='Wall Specifications', ifc_version='IFC4',
                          applicability=ids.Applicability(facets=[ids.EntityFacet(ifc_class='IfcWall')]),
                          requirement=ids.Requirement(facets=[ids.AttributeFacet(name='Name')]))

spec2 = ids.Specification(name='Hackathon Pset', ifc_version='IFC4',
                          applicability=ids.Applicability(facets=[ids.EntityFacet(ifc_class='IfcWall')]),
                          requirement=ids.Requirement(facets=[ids.PropertyFacet(property_set='Hackathon2024', property_name='AEC_Hack', datatype='IFCTEXT')]))

ids_data = ids.InformationDeliverySpecification(
    title="AEC Hackathon Test IDS",
    version="0.1",
    purpose="Testing",
    specifications=[spec1, spec3]
)

ids.IDSSerializer.save_ids(filepath='example_ids', ids=ids_data)
```


# Limitations

- This README is still under construction =)
- Currently not all metadata for IDS files are actually written to file. author and date are skipped

# Next Steps

The following features will be added next:

- Utility functions to easily create simple Applicabilities and Requirements


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "idstool",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "IDS,Information Delivery Specification,openBIM",
    "author": "",
    "author_email": "Alexander Hammett <alexander.hammett@preisigag.ch>",
    "download_url": "https://files.pythonhosted.org/packages/0b/9d/0a0d329cd31aa0214cd7925caa90a91de8af0e60921f21a58dc95556fafa/idstool-0.1.3.tar.gz",
    "platform": null,
    "description": "# idstool\n Python Tool to create IDS (Information delivery specification) files for openBIM workflows.\n\n Currently built on IDS version 0.9.6\n\n\n# Example\n\nAn example on how to use this library to create an IDS:\n\n```python\nimport idstool as ids\n\nspec1 = ids.Specification(name='Wall Specifications', ifc_version='IFC4',\n                          applicability=ids.Applicability(facets=[ids.EntityFacet(ifc_class='IfcWall')]),\n                          requirement=ids.Requirement(facets=[ids.AttributeFacet(name='Name')]))\n\nspec2 = ids.Specification(name='Hackathon Pset', ifc_version='IFC4',\n                          applicability=ids.Applicability(facets=[ids.EntityFacet(ifc_class='IfcWall')]),\n                          requirement=ids.Requirement(facets=[ids.PropertyFacet(property_set='Hackathon2024', property_name='AEC_Hack', datatype='IFCTEXT')]))\n\nids_data = ids.InformationDeliverySpecification(\n    title=\"AEC Hackathon Test IDS\",\n    version=\"0.1\",\n    purpose=\"Testing\",\n    specifications=[spec1, spec3]\n)\n\nids.IDSSerializer.save_ids(filepath='example_ids', ids=ids_data)\n```\n\n\n# Limitations\n\n- This README is still under construction =)\n- Currently not all metadata for IDS files are actually written to file. author and date are skipped\n\n# Next Steps\n\nThe following features will be added next:\n\n- Utility functions to easily create simple Applicabilities and Requirements\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Python Tool to create IDS (Information delivery specification) files",
    "version": "0.1.3",
    "project_urls": {
        "Homepage": "https://github.com/alexander-hammett/idstool"
    },
    "split_keywords": [
        "ids",
        "information delivery specification",
        "openbim"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2de6c342ff098dcf8cfce48a363b9ce3a0c620e97ac5a66939b1619e880e5b9a",
                "md5": "61b5b84028399c2be0c23dd1b5235089",
                "sha256": "feaa6ec68abdf3424e251652de5f7f84436f798f18769b450bc4b161585d861b"
            },
            "downloads": -1,
            "filename": "idstool-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "61b5b84028399c2be0c23dd1b5235089",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 10478,
            "upload_time": "2024-02-04T10:27:54",
            "upload_time_iso_8601": "2024-02-04T10:27:54.092213Z",
            "url": "https://files.pythonhosted.org/packages/2d/e6/c342ff098dcf8cfce48a363b9ce3a0c620e97ac5a66939b1619e880e5b9a/idstool-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0b9d0a0d329cd31aa0214cd7925caa90a91de8af0e60921f21a58dc95556fafa",
                "md5": "f6045812c44b4fd9bd5d43aa4263d16c",
                "sha256": "6bfdb00012c935b4ccd935a390fadf3f97522a4d6572102c181169a29a5a6101"
            },
            "downloads": -1,
            "filename": "idstool-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "f6045812c44b4fd9bd5d43aa4263d16c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 9955,
            "upload_time": "2024-02-04T10:27:56",
            "upload_time_iso_8601": "2024-02-04T10:27:56.691100Z",
            "url": "https://files.pythonhosted.org/packages/0b/9d/0a0d329cd31aa0214cd7925caa90a91de8af0e60921f21a58dc95556fafa/idstool-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-04 10:27:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "alexander-hammett",
    "github_project": "idstool",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "idstool"
}
        
Elapsed time: 3.21312s