Update project structure

.devcontainer/devcontainer.json

@@ -2,7 +2,7 @@
 	"name": "Gazelle",
 	"runArgs": ["--name", "gazelle"],
 	"build": { "dockerfile": "Dockerfile" },
-  "postCreateCommand": "cd gazelle && poetry install",
+  "postCreateCommand": "poetry install && cargo build",
 	"privileged": true,
 	"features": {
 		"ghcr.io/devcontainers/features/git:1": {},

.vscode/settings.json

@@ -14,12 +14,11 @@
   "files.exclude": {
     "**/.git": false,
     "**/bin": false,
-    "**/obj": true,
-    "**/target/": false,
+    "**/target/": true,
     "**/poetry.lock": true,
     "**/__pycache__": true,
     "**/.pytest_cache": true,
-    "**/.venv": false
+    "**/.venv": true
   },
 
   "git.autofetch": true,
@@ -38,7 +37,7 @@
   "powershell.suppressAdditionalExeNotFoundWarning": false,
 
   "python.analysis.autoFormatStrings": true,
-  "python.defaultInterpreterPath": "gazelle/.venv/bin/python",
+  "python.defaultInterpreterPath": ".venv/bin/python",
   "python.languageServer": "Pylance",
   "python.testing.pytestEnabled": true,
   "python.testing.pytestPath": "pytest",

Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "gazelle"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+pyo3 = { version = "0.21.2", features = ["extension-module"] }
+
+[lib]
+name = "gazelle"
+crate-type = ["cdylib"]

gazelle/pyproject.toml → pyproject.toml

@@ -1,12 +1,12 @@
 [tool.poetry]
 name = "gazelle"
 version = "0.1.0"
-readme = "../README.md"
+readme = "README.md"
 license = "AGPL-3.0-or-later"
 documentation = "https://docs.gazelle.sh"
-description = "A fast, open-source engine for civil engineers."
 repository = "https://github.com/gazellekit/gazelle.git"
 authors = ["James S. Bayley <https://www.linkedin.com/in/jsbayley>"]
+description = "A fast, open-source engine for civil engineers."
 packages = [{ include = "python" }]
 classifiers = [
   "Programming Language :: Rust",

python/__init__.py

@@ -0,0 +1,5 @@
+import gazelle as gz
+
+__doc__ = gz.__doc__
+if hasattr(gz, "__all__"):
+    __all__ = gz.__all__

gazelle/python/main.py → python/main.py

@@ -1,5 +1,5 @@
 import gazelle as gz
-from python.steel import SteelFabricator, SectionCategory, UniversalBeam
+from .steel import SteelFabricator, SectionCategory, UniversalBeam
 
 print("Welcome to Gazelle! 🦌")
 print(f'The answer is: {gz.sum_as_string(10, 32)}')

gazelle/python/steel.py → python/steel.py

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
-# Gazelle: A fast engine for civil engineering design.
+# Gazelle: A fast, open-source engine for civil engineers.
 # Copyright (C) 2024 James S. Bayley
 
 """
@@ -17,7 +17,7 @@
 from enum import Enum
 from typing import Generic, NewType, Tuple, TypeVar, Union
 
-from python.units import (
+from .units import (
   Area,
   Carbon,
   Centimetre,

gazelle/python/units.py → python/units.py

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
-# Gazelle: A fast engine for civil engineering design.
+# Gazelle: A fast, open-source engine for civil engineers.
 # Copyright (C) 2024 James S. Bayley
 
 

gazelle/rust/lib.rs → src/lib.rs

@@ -10,6 +10,7 @@ fn sum_as_string(a: usize, b: usize) -> PyResult<String> {
 /// the `lib.name` setting in the `Cargo.toml`, else Python will not be able to
 /// import the module.
 #[pymodule]
+#[pyo3(name="gazelle")]
 fn gazelle(m: &Bound<'_, PyModule>) -> PyResult<()> {
     m.add_function(wrap_pyfunction!(sum_as_string, m)?)?;
     Ok(())