diff options
| author | Ben Sima <ben@bensima.com> | 2025-11-22 14:47:58 -0500 |
|---|---|---|
| committer | Ben Sima <ben@bensima.com> | 2025-11-22 14:47:58 -0500 |
| commit | 9cb67c1cb478f996a0be54aadf2bc54e2ffb80bc (patch) | |
| tree | 22f6cd01c1fa4cdb7d6270adf5e4cc3433a646dc /Omni/Bild | |
| parent | 92cf4655e8799c53fe588149ac39748234ce582b (diff) | |
| parent | 7a36facb10cd5fc07bb60aa046aac9c27d0d5e4c (diff) | |
task: complete t-1o2bkufixnc (Merge)
Amp-Thread-ID:
https://ampcode.com/threads/T-ca3b086b-5a85-422a-b13d-256784c04221
Co-authored-by: Amp <amp@ampcode.com>
Diffstat (limited to 'Omni/Bild')
| -rw-r--r-- | Omni/Bild/README.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/Omni/Bild/README.md b/Omni/Bild/README.md new file mode 100644 index 0000000..e1c026c --- /dev/null +++ b/Omni/Bild/README.md @@ -0,0 +1,40 @@ +# Bild + +`bild` is the universal build tool. It can build and test everything in the repo. + +Examples: +```bash +bild --test Omni/Bild.hs # Build and test a namespace +bild --time 0 Omni/Cloud.nix # Build with no timeout +bild --plan Omni/Test.hs # Analyze build without building +``` + +When the executable is built, the output will go to `_/bin`. Example: + +```bash +# build the example executable +bild Omni/Bild/Example.py +# run the executable +_/bin/example +``` + +## Adding New Dependencies + +### Python Packages + +To add a new Python package as a dependency: + +1. Add the package name to `Omni/Bild/Deps/Python.nix` (alphabetically sorted) +2. Use it in your Python file with `# : dep <package-name>` comment at the top +3. Run `bild <yourfile.py>` to build with the new dependency + +Example: +```python +# : out myapp +# : dep stripe +# : dep pytest +import stripe +``` + +The package name must match the nixpkgs python package name (usually the PyPI name). +Check available packages: `nix-env -qaP -A nixpkgs.python3Packages | grep <name>` |
