scitex-affairs 0.1.0__tar.gz

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.
Files changed (133) hide show
  1. scitex_affairs-0.1.0/.gitignore +13 -0
  2. scitex_affairs-0.1.0/CHANGELOG.md +25 -0
  3. scitex_affairs-0.1.0/CLA.md +36 -0
  4. scitex_affairs-0.1.0/CONTRIBUTING.md +22 -0
  5. scitex_affairs-0.1.0/LICENSE +661 -0
  6. scitex_affairs-0.1.0/PKG-INFO +205 -0
  7. scitex_affairs-0.1.0/README.md +158 -0
  8. scitex_affairs-0.1.0/docs/scitex-icon-navy-inverted.png +0 -0
  9. scitex_affairs-0.1.0/docs/scitex-logo-blue-cropped.png +0 -0
  10. scitex_affairs-0.1.0/docs/sphinx/api/scitex_affairs.rst +28 -0
  11. scitex_affairs-0.1.0/docs/sphinx/conf.py +88 -0
  12. scitex_affairs-0.1.0/docs/sphinx/index.rst +32 -0
  13. scitex_affairs-0.1.0/docs/sphinx/installation.rst +12 -0
  14. scitex_affairs-0.1.0/docs/sphinx/quickstart.rst +42 -0
  15. scitex_affairs-0.1.0/docs/sphinx/requirements.txt +5 -0
  16. scitex_affairs-0.1.0/examples/catalog_report.py +14 -0
  17. scitex_affairs-0.1.0/examples/example.yaml +42 -0
  18. scitex_affairs-0.1.0/pyproject.toml +107 -0
  19. scitex_affairs-0.1.0/src/scitex_affairs/__init__.py +74 -0
  20. scitex_affairs-0.1.0/src/scitex_affairs/__main__.py +8 -0
  21. scitex_affairs-0.1.0/src/scitex_affairs/_django/__init__.py +3 -0
  22. scitex_affairs-0.1.0/src/scitex_affairs/_django/apps.py +9 -0
  23. scitex_affairs-0.1.0/src/scitex_affairs/_django/manifest.json +29 -0
  24. scitex_affairs-0.1.0/src/scitex_affairs/_django/static/scitex_affairs/affairs.css +73 -0
  25. scitex_affairs-0.1.0/src/scitex_affairs/_django/templates/scitex_affairs/dashboard.html +61 -0
  26. scitex_affairs-0.1.0/src/scitex_affairs/_django/urls.py +12 -0
  27. scitex_affairs-0.1.0/src/scitex_affairs/_django/views.py +82 -0
  28. scitex_affairs-0.1.0/src/scitex_affairs/_skills/scitex-affairs/01_installation.md +23 -0
  29. scitex_affairs-0.1.0/src/scitex_affairs/_skills/scitex-affairs/02_quick-start.md +17 -0
  30. scitex_affairs-0.1.0/src/scitex_affairs/_skills/scitex-affairs/03_python-api.md +18 -0
  31. scitex_affairs-0.1.0/src/scitex_affairs/_skills/scitex-affairs/04_cli-reference.md +19 -0
  32. scitex_affairs-0.1.0/src/scitex_affairs/_skills/scitex-affairs/20_env-vars.md +15 -0
  33. scitex_affairs-0.1.0/src/scitex_affairs/_skills/scitex-affairs/SKILL.md +57 -0
  34. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/.buildinfo +4 -0
  35. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_modules/index.html +263 -0
  36. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_modules/scitex_affairs/config.html +780 -0
  37. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_modules/scitex_affairs/describe.html +387 -0
  38. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_modules/scitex_affairs/render.html +333 -0
  39. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_modules/scitex_affairs/scenario.html +459 -0
  40. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_sources/api/scitex_affairs.rst.txt +28 -0
  41. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_sources/index.rst.txt +32 -0
  42. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_sources/installation.rst.txt +12 -0
  43. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_sources/quickstart.rst.txt +42 -0
  44. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/_sphinx_javascript_frameworks_compat.js +123 -0
  45. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/basic.css +925 -0
  46. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/check-solid.svg +4 -0
  47. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/clipboard.min.js +7 -0
  48. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/copy-button.svg +5 -0
  49. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/copybutton.css +94 -0
  50. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/copybutton.js +248 -0
  51. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/copybutton_funcs.js +73 -0
  52. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/badge_only.css +1 -0
  53. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/Roboto-Slab-Bold.woff +0 -0
  54. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/Roboto-Slab-Bold.woff2 +0 -0
  55. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/Roboto-Slab-Regular.woff +0 -0
  56. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/Roboto-Slab-Regular.woff2 +0 -0
  57. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/fontawesome-webfont.eot +0 -0
  58. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/fontawesome-webfont.svg +2671 -0
  59. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/fontawesome-webfont.ttf +0 -0
  60. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/fontawesome-webfont.woff +0 -0
  61. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/fontawesome-webfont.woff2 +0 -0
  62. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/lato-bold-italic.woff +0 -0
  63. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/lato-bold-italic.woff2 +0 -0
  64. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/lato-bold.woff +0 -0
  65. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/lato-bold.woff2 +0 -0
  66. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/lato-normal-italic.woff +0 -0
  67. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/lato-normal-italic.woff2 +0 -0
  68. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/lato-normal.woff +0 -0
  69. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/fonts/lato-normal.woff2 +0 -0
  70. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/css/theme.css +4 -0
  71. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/doctools.js +156 -0
  72. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/documentation_options.js +13 -0
  73. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/file.png +0 -0
  74. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/Lato/lato-bold.eot +0 -0
  75. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/Lato/lato-bold.ttf +0 -0
  76. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/Lato/lato-bold.woff +0 -0
  77. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/Lato/lato-bold.woff2 +0 -0
  78. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/Lato/lato-bolditalic.eot +0 -0
  79. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/Lato/lato-bolditalic.ttf +0 -0
  80. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/Lato/lato-bolditalic.woff +0 -0
  81. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/Lato/lato-bolditalic.woff2 +0 -0
  82. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/Lato/lato-italic.eot +0 -0
  83. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/Lato/lato-italic.ttf +0 -0
  84. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/Lato/lato-italic.woff +0 -0
  85. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/Lato/lato-italic.woff2 +0 -0
  86. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/Lato/lato-regular.eot +0 -0
  87. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/Lato/lato-regular.ttf +0 -0
  88. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/Lato/lato-regular.woff +0 -0
  89. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/Lato/lato-regular.woff2 +0 -0
  90. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot +0 -0
  91. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf +0 -0
  92. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff +0 -0
  93. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 +0 -0
  94. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot +0 -0
  95. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf +0 -0
  96. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff +0 -0
  97. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 +0 -0
  98. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/jquery.js +2 -0
  99. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/js/badge_only.js +1 -0
  100. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/js/theme.js +1 -0
  101. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/js/versions.js +228 -0
  102. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/language_data.js +199 -0
  103. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/minus.png +0 -0
  104. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/plus.png +0 -0
  105. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/pygments.css +75 -0
  106. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/searchtools.js +619 -0
  107. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/_static/sphinx_highlight.js +154 -0
  108. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/api/scitex_affairs.html +1022 -0
  109. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/genindex.html +769 -0
  110. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/index.html +317 -0
  111. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/installation.html +276 -0
  112. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/objects.inv +0 -0
  113. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/py-modindex.html +299 -0
  114. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/quickstart.html +303 -0
  115. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/search.html +279 -0
  116. scitex_affairs-0.1.0/src/scitex_affairs/_sphinx_html/searchindex.js +1 -0
  117. scitex_affairs-0.1.0/src/scitex_affairs/actuals.py +195 -0
  118. scitex_affairs-0.1.0/src/scitex_affairs/cli.py +375 -0
  119. scitex_affairs-0.1.0/src/scitex_affairs/config.py +478 -0
  120. scitex_affairs-0.1.0/src/scitex_affairs/describe.py +118 -0
  121. scitex_affairs-0.1.0/src/scitex_affairs/plot.py +84 -0
  122. scitex_affairs-0.1.0/src/scitex_affairs/py.typed +1 -0
  123. scitex_affairs-0.1.0/src/scitex_affairs/render.py +67 -0
  124. scitex_affairs-0.1.0/src/scitex_affairs/scenario.py +196 -0
  125. scitex_affairs-0.1.0/tests/e2e/test_standalone_app.py +54 -0
  126. scitex_affairs-0.1.0/tests/examples/test_catalog_report.py +24 -0
  127. scitex_affairs-0.1.0/tests/integration/test_cross_package_imports.py +28 -0
  128. scitex_affairs-0.1.0/tests/scitex_affairs/_django/test_apps.py +16 -0
  129. scitex_affairs-0.1.0/tests/scitex_affairs/test_actuals.py +34 -0
  130. scitex_affairs-0.1.0/tests/scitex_affairs/test_config.py +162 -0
  131. scitex_affairs-0.1.0/tests/scitex_affairs/test_render_plot.py +39 -0
  132. scitex_affairs-0.1.0/tests/scitex_affairs/test_scenario.py +51 -0
  133. scitex_affairs-0.1.0/tests/smoke/test_cli.py +30 -0
@@ -0,0 +1,13 @@
1
+ __pycache__/
2
+ *.py[cod]
3
+ .coverage
4
+ .pytest_cache/
5
+ .ruff_cache/
6
+ .venv/
7
+ build/
8
+ dist/
9
+ *.egg-info/
10
+ node_modules/
11
+ .worktrees/
12
+ # Sphinx local build output (the in-wheel src/<pkg>/_sphinx_html bundle IS tracked)
13
+ docs/sphinx/_build/
@@ -0,0 +1,25 @@
1
+ # Changelog
2
+
3
+ All notable changes to `scitex-affairs` are documented here. The format
4
+ follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and versions
5
+ follow [Semantic Versioning](https://semver.org/).
6
+
7
+ ## [Unreleased]
8
+
9
+ ## [0.1.0] - 2026-11-16
10
+
11
+ First public release. The package was developed privately as
12
+ `scitex-business` and renamed `scitex-affairs` before publication, because it
13
+ covers business and personal affairs.
14
+
15
+ - Add reusable catalog and dated pricing-policy validation.
16
+ - Add time-aware stock and flow scenario calculations with pandas reports.
17
+ - Add PostgreSQL actual-observation store through `scitex-dev` primitives.
18
+ - Add table, FigRecipe, Plotly, CLI, and SciTeX Hub rendering surfaces.
19
+ - Package the SciTeX skill under `src/scitex_affairs/_skills/`.
20
+ - Config at `$SCITEX_DIR/affairs/config.yaml` (override with `--config` or
21
+ `SCITEX_AFFAIRS_CONFIG`); actual observations in the `affairs_actuals` store.
22
+ - Lazy package exports (PEP 562): `import scitex_affairs` no longer loads pandas.
23
+ - Sphinx documentation, with the HTML bundle shipped inside the wheel.
24
+ - Standard SciTeX CI: the org `ci.yml` caller, CLA, PyPI trusted publishing on
25
+ tag, and syncing `main` to each release tag.
@@ -0,0 +1,36 @@
1
+ # SciTeX Contributor License Agreement (CLA)
2
+
3
+ Version 1.0 — Effective 2026-03-12
4
+
5
+ ## Purpose
6
+
7
+ SciTeX is licensed under AGPL-3.0 and follows a dual-licensing model:
8
+
9
+ - Researchers and individuals: free under AGPL-3.0.
10
+ - Enterprises and institutions: a commercial license may be offered.
11
+
12
+ The CLA preserves the project's ability to sustain that model while keeping
13
+ the contributor's copyright.
14
+
15
+ ## Agreement
16
+
17
+ By submitting a pull request or other contribution to a SciTeX repository,
18
+ you agree that:
19
+
20
+ 1. You retain copyright ownership of your contribution.
21
+ 2. You grant Yusuke Watanabe, and any successor entity operating SciTeX, a
22
+ perpetual, worldwide, non-exclusive, royalty-free, irrevocable license to
23
+ use, reproduce, modify, distribute, and sublicense the contribution,
24
+ including under alternative licenses that sustain SciTeX.
25
+ 3. The contribution is your original work, you have the right to grant this
26
+ license, and you have disclosed any compatible third-party source.
27
+ 4. The Project Lead is not obligated to use, merge, or maintain it.
28
+
29
+ ## How to sign
30
+
31
+ The CLA Assistant will ask you to sign on your first pull request. You may
32
+ sign by commenting:
33
+
34
+ > I have read and agree to the SciTeX CLA.
35
+
36
+ Questions may be raised in the repository issue tracker.
@@ -0,0 +1,22 @@
1
+ # Contributing to scitex-affairs
2
+
3
+ Thank you for helping make routine business reporting less repetitive.
4
+
5
+ ## Quick start
6
+
7
+ ```bash
8
+ uv pip install -e ".[all]"
9
+ ruff check .
10
+ python -m pytest
11
+ ```
12
+
13
+ Sign the [CLA](CLA.md) when prompted on your first pull request.
14
+
15
+ ## Standards
16
+
17
+ This package follows the SciTeX leaf-package conventions. Keep configuration,
18
+ PostgreSQL state, pandas descriptions, and rendering separated. New behavior
19
+ needs focused tests and documentation, and scenarios must distinguish stocks
20
+ from flows.
21
+
22
+ Use one logical change per pull request and explain why the change is needed.