Metadata-Version: 2.3
Name: civix
Version: 0.0.20
Summary: useful tools for civil engineering that are needed regularly in the daily tasks for a civil engineer
Author: mohamadalitellawi
Author-email: mohamadalitellawi <mohamadalitellawi@gmail.com>
License: MIT License
         
         Copyright (c) 2025 mohamadalitellawi
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3
Requires-Dist: numpy>=2.3.5
Requires-Dist: loguru>=0.7
Requires-Dist: pyyaml>=6.0
Requires-Dist: plotly>=5
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: civix[etabs] ; extra == 'all'
Requires-Dist: civix[ifc] ; extra == 'all'
Requires-Dist: civix[geom] ; extra == 'all'
Requires-Dist: civix[notebook] ; extra == 'all'
Requires-Dist: civix[streamlit] ; extra == 'all'
Requires-Dist: pythonnet>=3.0 ; extra == 'etabs'
Requires-Dist: rhino3dm>=8.17 ; extra == 'geom'
Requires-Dist: ifcopenshell>=0.8 ; extra == 'ifc'
Requires-Dist: notebook>=7.5.4 ; extra == 'notebook'
Requires-Dist: handcalcs>=1.11.0 ; extra == 'notebook'
Requires-Dist: streamlit>=1.57.0 ; extra == 'streamlit'
Requires-Python: >=3.12
Project-URL: Homepage, https://github.com/mohamadalitellawi/civix
Project-URL: Repository, https://github.com/mohamadalitellawi/civix
Provides-Extra: all
Provides-Extra: etabs
Provides-Extra: geom
Provides-Extra: ifc
Provides-Extra: notebook
Provides-Extra: streamlit
Description-Content-Type: text/markdown

# civix
python tools for Civil and Structural Engineering

## Release workflow

### 1. Pre-release checks (run locally)

Ruff is not enforced in CI — run manually before merging:

```bash
uv tool run ruff check .        # lint (Pyflakes F-rules)
uv tool run ruff format .       # auto-format
uv run pytest                   # all tests green
```

### 2. Merge feature branch → develop (squash)

```bash
git checkout develop
git merge --squash feature/<branch-name>
git commit -m "squashed: <short description>"
```

### 3. Bump version

```bash
uv version --bump patch          # e.g. 0.0.18 → 0.0.19
git add pyproject.toml uv.lock
git commit -m "bump version to $(uv version)"
```

### 4. Merge develop → main

```bash
git checkout main
git merge develop
git push origin main
```

CI detects the version change on `main`, creates the tag, runs tests, builds, and publishes to PyPI automatically.

## Streamlit app

```bash
uv run streamlit run streamlit_app/app.py
```

## Installation

```bash
pip install civix                      # core only (numpy, loguru, pyyaml, plotly, openpyxl)
pip install "civix[etabs]"             # + ETABS automation (Windows)
pip install "civix[ifc]"              # + IFC parsing (ifcopenshell)
pip install "civix[geom]"             # + Rhino/Grasshopper geometry
pip install "civix[notebook]"         # + Jupyter notebook + handcalcs rendering
pip install "civix[streamlit]"        # + Streamlit app
pip install "civix[all]"              # everything
```

With `uv`:

```bash
uv add civix
uv add "civix[etabs,ifc,geom]"
uv add "civix[all]"
```
