pyifc 0.0.0

Utilities for .ifc files

pyifc: Utilities for .ifc files

What is it?

pyifc is a Python package that provides utilities for working with .ifc files.

According to Wikipedia:

The Industry Foundation Classes (IFC) data model is intended to describe architectural, building and construction industry data.

IFC format provides interoperability. This way, it doesn't matter what software you work on or what file format you deal with on a daily basis. There is a high probability that your software has import and export functions for .ifc files. Learn more about IFC format here.

At this point, the project is in development. If you have any ideas on how it can be improved check Contributions. If you want to know what the project currently consists of, check Modules.

Table of Contents

Modules | Installation | Documentation | Usage | Found a bug? | Changelog | Contributions | Code of Conduct | License

Modules

compress - set of functions responsible for compressing files

In the future:

compare - set of functions responsible for comparing files
count - set of functions responsible for counting elements in a file
modify - set of functions responsible for modifying files

Installation

Use the package manager pip to install pyifc.

pip install pyifc

Unfortunately dependency package ifcopenshell is not distributed via PyPi. Hence you can get error while trying to import pyifc:

ModuleNotFoundError: No module named 'ifcopenshell'

To install ifcopenshell run from current directory:

python init_script.py

The script will download ifcopenshell based on given or automatically detected arguments. Possible arguments are listed below:

python init_script.py -h
usage: init_script.py [-h] [-s {linux,win,macos}] [-a {32,64}] [-v {37,38,39}]

Download ifcopenshell based on platform system, platform architecture 
and running python version.

optional arguments:
  -h, --help            show this help message and exit
  -s {linux,win,macos}, --system {linux,win,macos}
                        Platform system.
  -a {32,64}, --architecture {32,64}
                        Platform architecture.
  -v {37,38,39}, --python-version {37,38,39}
                        Running python version; string of major and 
                        minor version, e.g. '39'. pyifc supports python >= 3.7.

Documentation

Usage

Found a bug?

Feel free to add a new issue on the the pyifc repository. If you found a solution, feel free to add a new pull request.

Changelog

See CHANGELOG.md.

Contributions

See CONTRIBUTING.md.

Code of Conduct

Everyone interacting in the pyifc project's development is expected to follow the Code of Conduct.

License

pyifc is released under the terms of the MIT License.