birm 0.0.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- birm/__init__.py +1 -0
- birm-0.0.0.dist-info/METADATA +93 -0
- birm-0.0.0.dist-info/RECORD +4 -0
- birm-0.0.0.dist-info/WHEEL +4 -0
birm/__init__.py
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
__version__ = "0.0.0"
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
Metadata-Version: 2.3
|
|
2
|
+
Name: birm
|
|
3
|
+
Version: 0.0.0
|
|
4
|
+
Summary: Bayesian Impulse-Response Modeling
|
|
5
|
+
License: Apache 2.0
|
|
6
|
+
Requires-Dist: pymc>=6.3.2
|
|
7
|
+
Requires-Python: >=3.12, <3.15
|
|
8
|
+
Project-URL: Homepage, https://github.com/hrmerrill/birm
|
|
9
|
+
Project-URL: Documentation, https://hrmerrill.github.io/birm
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
|
|
12
|
+
# `birm`: Bayesian Impulse-Response Modeling
|
|
13
|
+
|
|
14
|
+
# UNDER CONSTRUCTION
|
|
15
|
+
|
|
16
|
+
None of the below is true yet.
|
|
17
|
+
|
|
18
|
+
<p align="center">
|
|
19
|
+
<img src="https://img.shields.io/pypi/v/birm?style=flat-square&color=111111&label=pypi" alt="pypi">
|
|
20
|
+
<img src="https://github.com/hrmerrill/birm/actions/workflows/ci.yml/badge.svg?style=flat-square" alt="CI">
|
|
21
|
+
<img src="https://raw.githubusercontent.com/hrmerrill/birm/badges/coverage.svg" alt="coverage">
|
|
22
|
+
<img src="https://raw.githubusercontent.com/hrmerrill/birm/badges/interrogate_badge.svg" alt="docstring coverage">
|
|
23
|
+
</p>
|
|
24
|
+
|
|
25
|
+
## About
|
|
26
|
+
|
|
27
|
+
TODO
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
TODO
|
|
32
|
+
|
|
33
|
+
## For Developers
|
|
34
|
+
|
|
35
|
+
### Setup
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
uv sync # install package + dev dependencies into .venv
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Development workflow
|
|
42
|
+
|
|
43
|
+
All changes should be made on a branch and merged to `main` via pull request.
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
git checkout -b feat/my-feature # or fix/, docs/, refactor/, etc.
|
|
47
|
+
|
|
48
|
+
# ... make changes ...
|
|
49
|
+
|
|
50
|
+
make format # auto-fix formatting and lint violations
|
|
51
|
+
make check # lint, type-check, and verify docstring coverage
|
|
52
|
+
make test # run tests with coverage (90% minimum)
|
|
53
|
+
make docs-serve # preview docs locally at http://127.0.0.1:8000
|
|
54
|
+
|
|
55
|
+
git push -u origin feat/my-feature
|
|
56
|
+
# open a pull request on GitHub
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
CI runs `make check` and `make test` automatically on every push and pull request. A PR cannot be merged if CI fails.
|
|
60
|
+
|
|
61
|
+
### What triggers what
|
|
62
|
+
|
|
63
|
+
| Action | CI checks | Docs deployed | Package published |
|
|
64
|
+
|---|---|---|---|
|
|
65
|
+
| Push to any branch / open PR | ✓ | | |
|
|
66
|
+
| Merge to `main` | ✓ | ✓ | |
|
|
67
|
+
| Push a `v*` tag | | | ✓ |
|
|
68
|
+
|
|
69
|
+
**Docs-only change** (e.g. fix a typo in `docs/` or a docstring): open a PR and merge to `main`. Docs redeploy automatically, no tag needed.
|
|
70
|
+
|
|
71
|
+
**Code-only change** (e.g. bug fix): merge to `main`, then tag when ready to publish (see below). Docs will also redeploy on merge, reflecting any updated docstrings.
|
|
72
|
+
|
|
73
|
+
### Publishing a new package version
|
|
74
|
+
|
|
75
|
+
1. Bump the version in `pyproject.toml`:
|
|
76
|
+
```bash
|
|
77
|
+
# choose one:
|
|
78
|
+
make patch # 0.1.0 → 0.1.1 (bug fixes)
|
|
79
|
+
make minor # 0.1.0 → 0.2.0 (new features)
|
|
80
|
+
make major # 0.1.0 → 1.0.0 (breaking changes)
|
|
81
|
+
```
|
|
82
|
+
2. Commit, tag, and push:
|
|
83
|
+
```bash
|
|
84
|
+
git add pyproject.toml
|
|
85
|
+
git commit -m "chore: bump version to v0.x.x"
|
|
86
|
+
git tag v0.x.x
|
|
87
|
+
git push && git push --tags
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Pushing the tag triggers the publish workflow, which runs the test suite and publishes the package to PyPI. Check that the release appeared:
|
|
91
|
+
|
|
92
|
+
- Package: https://pypi.org/project/birm/
|
|
93
|
+
- Docs: https://hrmerrill.github.io/birm/
|