diff --git a/.github/workflows/ci-ifc5d-pypi.yaml b/.github/workflows/ci-ifc5d-pypi.yaml new file mode 100644 index 0000000000..b626316267 --- /dev/null +++ b/.github/workflows/ci-ifc5d-pypi.yaml @@ -0,0 +1,35 @@ +name: ci-ifc5d-pypi + +on: + workflow_dispatch: + +jobs: + activate: + runs-on: ubuntu-latest + if: | + github.repository == 'IfcOpenShell/IfcOpenShell' + steps: + - name: Set env + run: echo ok go + + build: + needs: activate + runs-on: ubuntu-latest + strategy: + fail-fast: false + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 # https://github.com/actions/setup-python + with: + python-version: '3.11' # Version range or exact version of a Python version to use, using SemVer's version range syntax + - name: Compile + run: | + pip install build + cd src/ifc5d && + make dist + - name: Publish a Python distribution to PyPI + uses: ortega2247/pypi-upload-action@master + with: + user: __token__ + password: ${{ secrets.PYPI_API_TOKEN }} + packages_dir: src/ifc5d/dist diff --git a/src/ifc5d/Makefile b/src/ifc5d/Makefile new file mode 100644 index 0000000000..8ae5d28733 --- /dev/null +++ b/src/ifc5d/Makefile @@ -0,0 +1,38 @@ +# Ifc5D - IFC costing utility +# Copyright (C) 2020-2024 Dion Moult +# +# This file is part of Ifc5D. +# +# Ifc5D is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ifc5D is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with Ifc5D. If not, see . + +VERSION:=$(shell cat ../../VERSION) +SED:=sed -i +ifeq ($(UNAME_S),Darwin) +SED:=sed -i '' -e +endif + +.PHONY: qa +qa: + black . + +.PHONY: dist +dist: + rm -rf dist + cp pyproject.toml pyproject.toml.bak + cp ifc5d/__init__.py __init__.py.bak + $(SED) 's/version = "0.0.0"/version = "$(VERSION)"/' pyproject.toml + $(SED) 's/version = "0.0.0"/version = "$(VERSION)"/' ifc5d/__init__.py + python -m build + mv pyproject.toml.bak pyproject.toml + mv __init__.py.bak ifc5d/__init__.py diff --git a/src/ifc5d/ifc5d/__init__.py b/src/ifc5d/ifc5d/__init__.py new file mode 100644 index 0000000000..cfeea274e5 --- /dev/null +++ b/src/ifc5d/ifc5d/__init__.py @@ -0,0 +1,19 @@ +# Ifc5D - IFC costing utility +# Copyright (C) 2020-2024 Dion Moult +# +# This file is part of Ifc5D. +# +# Ifc5D is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ifc5D is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with Ifc5D. If not, see . + +__version__ = version = "0.0.0" diff --git a/src/ifc5d/pyproject.toml b/src/ifc5d/pyproject.toml new file mode 100644 index 0000000000..55aaf9e6de --- /dev/null +++ b/src/ifc5d/pyproject.toml @@ -0,0 +1,29 @@ +[build-system] +requires = ["setuptools>=61.0"] +build-backend = "setuptools.build_meta" + +[project] +name = "ifc5d" +version = "0.0.0" +authors = [ + { name="Dion Moult", email="dion@thinkmoult.com" }, +] +description = "IFC 5D costing library for quantity take-off and schedule production" +readme = "README.md" +keywords = ["IFC", "5D", "BIM"] +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)", +] +dependencies = [ + "ifcopenshell", +] + +[project.urls] +Homepage = "http://ifcopenshell.org" +Documentation = "https://docs.ifcopenshell.org" +Issues = "https://github.com/IfcOpenShell/IfcOpenShell/issues" + +[tool.setuptools.packages.find] +include = ["ifc5d"] +exclude = ["test*"] diff --git a/src/ifcopenshell-python/docs/ifc5d.rst b/src/ifcopenshell-python/docs/ifc5d.rst index 966c9262d6..4c02ede4fd 100644 --- a/src/ifcopenshell-python/docs/ifc5d.rst +++ b/src/ifcopenshell-python/docs/ifc5d.rst @@ -3,3 +3,10 @@ Ifc5D Ifc5D is a collection of utilities of manipulating cost-related data to and from formats, reports, and optimisation engines. + +PyPI +---- + +.. code-block:: + + pip install ifc5d