creatureos 0.1.0__tar.gz

creatureos-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

creatureos-0.1.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include LICENSE
+include README.md
+recursive-include creatureos/templates *
+recursive-include creatureos/static *
+global-exclude __pycache__ *.py[cod]

creatureos-0.1.0/PKG-INFO

@@ -0,0 +1,248 @@
+Metadata-Version: 2.4
+Name: creatureos
+Version: 0.1.0
+Summary: Local-first CreatureOS runtime for persistent Codex creatures
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/CreatureOS/creatureos
+Project-URL: Repository, https://github.com/CreatureOS/creatureos
+Project-URL: Issues, https://github.com/CreatureOS/creatureos/issues
+Keywords: codex,creatures,fastapi,local-first,sqlite
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi
+Requires-Dist: jinja2
+Requires-Dist: python-multipart
+Requires-Dist: uvicorn
+Provides-Extra: test
+Requires-Dist: httpx; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+# CreatureOS
+
+CreatureOS is a local-first runtime for persistent Codex creatures.
+
+It gives you a small ambient habitat of specialized creatures that can:
+- watch a workspace over time
+- keep durable notes, memory, and activity reports
+- chat in a web UI
+- practice habits on a schedule and surface useful things without needing a fresh prompt every time
+- work with local documents, attachments, and browser flows as part of their normal job
+- keep private workshop scripts, files, templates, and reports that make repeated work easier
+
+CreatureOS is intentionally opinionated:
+- chats get fresh Codex threads
+- habit runs stay on a persistent creature thread
+- state lives locally in SQLite
+- creatures use purpose and habits as their authority rather than a matrix of manual capability grants
+- The Keeper helps summon and shape the rest of the habitat
+
+## Prerequisites
+
+CreatureOS itself is a Python app, but it wraps the Codex CLI.
+
+You should have:
+- Python `3.12+`
+- the `codex` CLI available on your `PATH`
+- Codex authenticated locally
+
+SQLite uses Python's built-in `sqlite3` module. There is no separate database server to install.
+
+Optional:
+- Tailscale, if you want private cross-device access with `--tailscale`
+
+## Install
+
+Install from a checkout:
+
+```bash
+python3 -m pip install -e .
+```
+
+Once published to PyPI, the install command will be:
+
+```bash
+pip install creatureos
+```
+
+## Start
+
+Initialize the database once:
+
+```bash
+creatureos init-db
+```
+
+Start CreatureOS in safe local-only mode:
+
+```bash
+creatureos serve --workspace /path/to/workspace
+```
+
+That binds to:
+- `127.0.0.1:404` by default
+
+Serve on localhost plus the detected Tailscale IPv4:
+
+```bash
+creatureos serve --workspace /path/to/workspace --tailscale
+```
+
+That binds to:
+- `127.0.0.1:404`
+- the detected Tailscale IPv4 on the same port
+
+If no Tailscale IPv4 is detected, it falls back to localhost-only.
+
+Force a fresh onboarding environment scan on boot:
+
+```bash
+creatureos serve --workspace /path/to/workspace --force-scan
+```
+
+## Working Root And Data
+
+If you do not pass `--workspace`, CreatureOS uses your current working directory as the primary working root for creature file work.
+
+The onboarding scan is broader than that. It looks across likely work directories on the machine so The Keeper can form a first impression of the kind of work you do.
+
+For repeatable launches, prefer setting the workspace explicitly with:
+- `creatureos --workspace /path/to/workspace serve`
+
+or with:
+- `CREATURE_OS_WORKSPACE_ROOT`
+
+Runtime state lives under:
+
+```text
+~/.local/state/creatureos
+```
+
+on Linux by default.
+
+On macOS the default is:
+
+```text
+~/Library/Application Support/CreatureOS
+```
+
+On Windows the default is:
+
+```text
+%LOCALAPPDATA%\CreatureOS
+```
+
+Override that explicitly with:
+- `creatureos --data-dir /path/to/data serve`
+- `CREATURE_OS_DATA_DIR`
+- `CREATURE_OS_DB_PATH`
+
+## Environment
+
+- `CREATURE_OS_WORKSPACE_ROOT`: primary working root for creature file work
+- `CREATURE_OS_DATA_DIR`: runtime data directory
+- `CREATURE_OS_DB_PATH`: SQLite path override
+- `CREATURE_OS_HOST`: bind host override for single-bind serve mode
+- `CREATURE_OS_PUBLIC_HOST`: display host used in generated URLs
+- `CREATURE_OS_PORT`: port override
+- `CREATURE_OS_CODEX_BIN`: Codex CLI binary
+- `CREATURE_OS_MODEL`: model override
+- `CREATURE_OS_REASONING_EFFORT`: reasoning effort override
+- `CREATURE_OS_TIMEOUT_SECONDS`: read-only run timeout
+- `CREATURE_OS_WRITE_TIMEOUT_SECONDS`: write-enabled run timeout
+- `CREATURE_OS_PYTHON_BIN`: Python interpreter used by helper scripts
+
+## Development
+
+Common commands:
+
+```bash
+python3 -m py_compile creatureos/cli.py creatureos/web.py creatureos/service.py creatureos/storage.py creatureos/config.py creatureos/codex_cli.py
+node --check creatureos/static/creature_os.js
+python3 -m creatureos.cli --help
+python3 -m creatureos.cli serve --help
+```
+
+Health check:
+
+```bash
+curl http://127.0.0.1:404/healthz
+```
+
+Testing:
+
+```bash
+python3 -m pytest
+```
+
+Browser smoke test:
+
+```bash
+CREATURE_OS_RUN_BROWSER_SMOKE=1 python3 -m pytest -m browser
+```
+
+Storage-focused guardrails:
+
+```bash
+python3 scripts/check_storage_sql.py
+python3 scripts/storage_smoke.py
+```
+
+## Packaging
+
+Build an sdist and wheel:
+
+```bash
+python3 -m pip install build twine
+python3 -m build
+python3 -m twine check dist/*
+```
+
+CreatureOS wheels bundle:
+- templates
+- static assets
+
+so the installed app can run outside a source checkout.
+
+## Publishing
+
+CreatureOS is set up for trusted publishing with GitHub Actions.
+
+Test phase on TestPyPI:
+- add this GitHub repo as a trusted publisher in TestPyPI
+- run the `Publish Package` workflow manually with target `testpypi`
+
+Real release on PyPI:
+- add this GitHub repo as a trusted publisher in PyPI
+- create a GitHub release
+- the same workflow publishes to PyPI automatically on `release.published`
+
+The CI workflow also smoke-installs the built wheel so packaging regressions get caught before release.
+
+## Repo Layout
+
+- runtime package: `creatureos/`
+- UI assets: `creatureos/templates/`, `creatureos/static/`
+- helper scripts: `scripts/`
+- tests: `tests/`
+
+## Notes
+
+- `serve` runs a small supervisor that restarts the worker when core runtime files change.
+- Static JS and CSS are served with revalidation headers to avoid stale browser state.
+- If a server is already running for the same CreatureOS data directory, a second `serve` exits instead of starting a duplicate process.
+
+## License
+
+CreatureOS is licensed under Apache 2.0. See [LICENSE](LICENSE).

creatureos-0.1.0/README.md

@@ -0,0 +1,217 @@
+# CreatureOS
+
+CreatureOS is a local-first runtime for persistent Codex creatures.
+
+It gives you a small ambient habitat of specialized creatures that can:
+- watch a workspace over time
+- keep durable notes, memory, and activity reports
+- chat in a web UI
+- practice habits on a schedule and surface useful things without needing a fresh prompt every time
+- work with local documents, attachments, and browser flows as part of their normal job
+- keep private workshop scripts, files, templates, and reports that make repeated work easier
+
+CreatureOS is intentionally opinionated:
+- chats get fresh Codex threads
+- habit runs stay on a persistent creature thread
+- state lives locally in SQLite
+- creatures use purpose and habits as their authority rather than a matrix of manual capability grants
+- The Keeper helps summon and shape the rest of the habitat
+
+## Prerequisites
+
+CreatureOS itself is a Python app, but it wraps the Codex CLI.
+
+You should have:
+- Python `3.12+`
+- the `codex` CLI available on your `PATH`
+- Codex authenticated locally
+
+SQLite uses Python's built-in `sqlite3` module. There is no separate database server to install.
+
+Optional:
+- Tailscale, if you want private cross-device access with `--tailscale`
+
+## Install
+
+Install from a checkout:
+
+```bash
+python3 -m pip install -e .
+```
+
+Once published to PyPI, the install command will be:
+
+```bash
+pip install creatureos
+```
+
+## Start
+
+Initialize the database once:
+
+```bash
+creatureos init-db
+```
+
+Start CreatureOS in safe local-only mode:
+
+```bash
+creatureos serve --workspace /path/to/workspace
+```
+
+That binds to:
+- `127.0.0.1:404` by default
+
+Serve on localhost plus the detected Tailscale IPv4:
+
+```bash
+creatureos serve --workspace /path/to/workspace --tailscale
+```
+
+That binds to:
+- `127.0.0.1:404`
+- the detected Tailscale IPv4 on the same port
+
+If no Tailscale IPv4 is detected, it falls back to localhost-only.
+
+Force a fresh onboarding environment scan on boot:
+
+```bash
+creatureos serve --workspace /path/to/workspace --force-scan
+```
+
+## Working Root And Data
+
+If you do not pass `--workspace`, CreatureOS uses your current working directory as the primary working root for creature file work.
+
+The onboarding scan is broader than that. It looks across likely work directories on the machine so The Keeper can form a first impression of the kind of work you do.
+
+For repeatable launches, prefer setting the workspace explicitly with:
+- `creatureos --workspace /path/to/workspace serve`
+
+or with:
+- `CREATURE_OS_WORKSPACE_ROOT`
+
+Runtime state lives under:
+
+```text
+~/.local/state/creatureos
+```
+
+on Linux by default.
+
+On macOS the default is:
+
+```text
+~/Library/Application Support/CreatureOS
+```
+
+On Windows the default is:
+
+```text
+%LOCALAPPDATA%\CreatureOS
+```
+
+Override that explicitly with:
+- `creatureos --data-dir /path/to/data serve`
+- `CREATURE_OS_DATA_DIR`
+- `CREATURE_OS_DB_PATH`
+
+## Environment
+
+- `CREATURE_OS_WORKSPACE_ROOT`: primary working root for creature file work
+- `CREATURE_OS_DATA_DIR`: runtime data directory
+- `CREATURE_OS_DB_PATH`: SQLite path override
+- `CREATURE_OS_HOST`: bind host override for single-bind serve mode
+- `CREATURE_OS_PUBLIC_HOST`: display host used in generated URLs
+- `CREATURE_OS_PORT`: port override
+- `CREATURE_OS_CODEX_BIN`: Codex CLI binary
+- `CREATURE_OS_MODEL`: model override
+- `CREATURE_OS_REASONING_EFFORT`: reasoning effort override
+- `CREATURE_OS_TIMEOUT_SECONDS`: read-only run timeout
+- `CREATURE_OS_WRITE_TIMEOUT_SECONDS`: write-enabled run timeout
+- `CREATURE_OS_PYTHON_BIN`: Python interpreter used by helper scripts
+
+## Development
+
+Common commands:
+
+```bash
+python3 -m py_compile creatureos/cli.py creatureos/web.py creatureos/service.py creatureos/storage.py creatureos/config.py creatureos/codex_cli.py
+node --check creatureos/static/creature_os.js
+python3 -m creatureos.cli --help
+python3 -m creatureos.cli serve --help
+```
+
+Health check:
+
+```bash
+curl http://127.0.0.1:404/healthz
+```
+
+Testing:
+
+```bash
+python3 -m pytest
+```
+
+Browser smoke test:
+
+```bash
+CREATURE_OS_RUN_BROWSER_SMOKE=1 python3 -m pytest -m browser
+```
+
+Storage-focused guardrails:
+
+```bash
+python3 scripts/check_storage_sql.py
+python3 scripts/storage_smoke.py
+```
+
+## Packaging
+
+Build an sdist and wheel:
+
+```bash
+python3 -m pip install build twine
+python3 -m build
+python3 -m twine check dist/*
+```
+
+CreatureOS wheels bundle:
+- templates
+- static assets
+
+so the installed app can run outside a source checkout.
+
+## Publishing
+
+CreatureOS is set up for trusted publishing with GitHub Actions.
+
+Test phase on TestPyPI:
+- add this GitHub repo as a trusted publisher in TestPyPI
+- run the `Publish Package` workflow manually with target `testpypi`
+
+Real release on PyPI:
+- add this GitHub repo as a trusted publisher in PyPI
+- create a GitHub release
+- the same workflow publishes to PyPI automatically on `release.published`
+
+The CI workflow also smoke-installs the built wheel so packaging regressions get caught before release.
+
+## Repo Layout
+
+- runtime package: `creatureos/`
+- UI assets: `creatureos/templates/`, `creatureos/static/`
+- helper scripts: `scripts/`
+- tests: `tests/`
+
+## Notes
+
+- `serve` runs a small supervisor that restarts the worker when core runtime files change.
+- Static JS and CSS are served with revalidation headers to avoid stale browser state.
+- If a server is already running for the same CreatureOS data directory, a second `serve` exits instead of starting a duplicate process.
+
+## License
+
+CreatureOS is licensed under Apache 2.0. See [LICENSE](LICENSE).

creatureos-0.1.0/creatureos/__init__.py

@@ -0,0 +1,3 @@
+from __future__ import annotations
+
+__all__ = []

creatureos-0.1.0/creatureos/__main__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from .cli import main
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())