pip install setup

DerekAmuna · DerekAmuna · commit 005c2d39a035 · 2025-06-30T17:36:22.000Z
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1 @@
+recursive-include file_converters/ifcjson *
diff --git a/README.md b/README.md
@@ -1,34 +1,44 @@
 # IFC2JSON_python
+
 Python converter from IFC SPF to JSON
 
 # Getting Started
 
 ## Requirements
+
 - ifcopenshell (using conda or in folder ./ifcopenshell)
 
 ## Installation ifcopenshell using Conda
 
-1. Download the Conda installer for your OS setup. https://docs.conda.io/en/latest/miniconda.html
+1. Download the Conda installer for your OS setup. <https://docs.conda.io/en/latest/miniconda.html>
 2. After installing Conda, create an environment for IFC.JSON with:
+
     ```
     conda create --name ifcjson
     ```
+
 3. Then activate the new environment:
+
     ```
     conda activate ifcjson
     ```
+
 4. Install ifcopenshell from conda-forge:
+
     ```
     conda install -c conda-forge ifcopenshell
     ```
 
 ## Installation ifcopenshell from direct download
-Download a recent copy of ifcopenshell from: https://builds.ifcopenshell.org/
+
+Download a recent copy of ifcopenshell from: <https://builds.ifcopenshell.org/>
 
 ## Usage
+
 ```
 python ifc2json.py -i model.ifc -o model_-_ifcjson4.json -v 4
 ```
+
 ```
 optional arguments:
   -h, --help  show this help message and exit
@@ -37,6 +47,20 @@ optional arguments:
   -v V        IFC.JSON version, options: "4"(default), "5a"
 ```
 
+## Importing as a Python package
+
+```bash
+pip install git+<https://github.com/IFCJSON-Team/IFC2JSON_python.git>
+```
+
+After installing with pip, you can import the package in your Python code:
+
+```python
+from ifcjson import ifc2json4, ifc2json5a, mesh, reader, to_ifcopenshell, common
+# Example usage:
+# from ifcjson.ifc2json4 import some_function
+```
+
 ## Additional Requirements for Roundtrip and IFC.JSON → IFC SPF Conversion
 
 - The roundtrip tests and the conversion from IFC.JSON to IFC SPF require the `pandas` library.
@@ -63,7 +87,7 @@ This keeps the minimal install lightweight for users who only need IFC → JSON
 
 # Running Tests
 
-A test converting a set of sample files is provided to verify the roundtrip conversion from IFC to JSON and back.  
+A test converting a set of sample files is provided to verify the roundtrip conversion from IFC to JSON and back.
 This test will process all `.ifc` files in `samples/input/`, write results to `samples/output/`, and check the validity of the conversion.
 
 To run the test, use the following command from your project root:
@@ -76,4 +100,4 @@ python -m unittest file_converters/tests/test_samples.py
 - The test checks for required keys and schema version in the generated JSON files.
 - Make sure your input files are placed in `samples/input/`.
 
----
+---
diff --git a/file_converters/__init__.py b/file_converters/__init__.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,17 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ifc2json"
+version = "0.1.0"
+description = "A tool to convert IFC files to JSON and back."
+authors = [
+    { name="Jan Brouwer", email="jan@brewsky.nl" }
+]
+readme = "README.md"
+requires-python = ">=3.7"
+dependencies = ["ifcopenshell","pandas"]
+
+[project.urls]
+"Homepage" = "https://github.com/IFCJSON-Team/IFC2JSON_python"
diff --git a/setup.py b/setup.py
@@ -0,0 +1,14 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="ifc2json",
+    version="0.1.0",
+    description="A tool to convert IFC files to JSON and back.",
+    author="Jan Brouwer",
+    author_email="jan@brewsky.nl",
+    packages=find_packages(where="file_converters"),
+    package_dir={"": "file_converters"},
+    include_package_data=True,
+    install_requires=["ifcopenshell","pandas"],
+    python_requires=">=3.7",
+)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+recursive-include file_converters/ifcjson *`