picop 1.44.16__tar.gz

picop-1.44.16/COVERAGE.md

@@ -0,0 +1,167 @@
+# cypy Coverage
+
+Product contract for what `cypy` is, what it ships, and how to choose helpers.
+
+`cypy` is **not** a reimplementation of the Python standard library, and it is **not** a full 1:1 port of Cython’s `Includes/cpython`. It is a curated **CPython C-API accelerator** for Cython on **Python ≥ 3.14**.
+
+Authoritative symbol lists: `src/cypy/__init__.py` / `__init__.pxd` `__all__`, plus `cypy.hot` for micro-opt starters. Per-module decisions: [`docs/modules/`](docs/modules/).
+Timed public-ops checklist: [`docs/OPS_INVENTORY.md`](docs/OPS_INVENTORY.md) (gate: `scripts/ops_inventory_coverage.py --strict`).
+
+---
+
+## Product tiers
+
+| Tier | Who | Import | Contents |
+|------|-----|--------|----------|
+| **Core** | Micro-opts / typed hot paths | `cypy.hot` (preferred) or `from cypy import …` | Typed containers, bytes/str, ANSI, GC toggles, string value ops |
+| **Protocols** | Unknown concrete type | `cypy` / `cypy.cy*` | Abstract mapping/sequence/number/object bridges |
+| **Runtime** | Extension / embedding authors | `cypy` public + **cimport** SDK | datetime, codecs, marshal, file, weakref, capsule, contextvars, thin clocks, process plumbing |
+
+**Rule of thumb:** prefer **Core** when the type is known; use **Protocols** only when it is not; use **Runtime** for non-hot-path / embedding needs.
+
+### Core (prefer for micro-opts)
+
+| Module | Maps to | Surface | Notes |
+|--------|---------|---------|--------|
+| `cydict` | `dict` | public + cimport | `dict_get`, `dict_pop`, `dict_set`, `dict_len`, `dict_eq`, … |
+| `cydeque` | `collections.deque` | public | `deque_eq` |
+| `cyrange` | `range` | public | `range_eq` |
+| `cylist` | `list` | public + cimport | `list_append`, `list_get` / `list_get_checked`, `list_len`, `list_eq`, … |
+| `cyset` | `set` / `frozenset` | public + cimport | `set_add`, `set_contains`, `set_eq`, `frozenset_eq`, … |
+| `cytuple` | `tuple` | public + cimport | `tuple_get`, `tuple_len`, `tuple_pack*`; builders mostly cimport |
+| `cybytes` | `bytes` | public + cimport | `bytes_len`, `bytes_contains`, `bytes_eq`, `bytes_ne`, `bytes_startswith`, `bytes_endswith`, `bytes_bytearray_eq`; `bytes_as_string` cimport-only |
+| `cybytearray` | `bytearray` | public + cimport | `bytearray_len`, `bytearray_eq`, `bytearray_ne`, `bytearray_contains`, `bytearray_from_object`, … |
+| `cystr` | `str` value ops | public subset + cimport | `str_len`, `str_eq`, `str_cmp`, `str_lt`/`le`/`gt`/`ge`, `str_contains`, coerce helpers, … |
+| `cyunicode` | UTF-8 / intern | public subset + cimport | `uintern`, `uutf8_bytes`; `unicode_from_string` / `uutf8` cimport |
+| `cyansi` | terminal SGR | public | Not CPython; builds on unicode intern |
+| `cygc` | GC | public | `gc_collect`, `gc_is_enabled`, … |
+| `cyarray` / `cymemoryview` / `cybuffer` / `cyslice` | buffers / slice | public | `array_eq` / `array_ne`; `memoryview_eq` / `memoryview_ne`; `buf_eq`; `slice_eq`; sequences/buffers adjacent to Core |
+
+**Curated starter export:** [`cypy.hot`](src/cypy/hot.py) — see [`examples/STARTER.md`](examples/STARTER.md).
+
+### 1.0 freeze (Core + cimport contracts)
+
+As of **`1.0.0`**:
+
+| Surface | Frozen? | Contract |
+|---------|---------|----------|
+| `cypy.__all__` | **Yes** | Core star-import / discovery set — additive in minors; drop/rename/semantic change → major |
+| `cypy.hot.__all__` | **Yes** | Micro-opt marketing set — same policy |
+| Full public barrel (`from cypy import name` beyond `__all__`) | Protocols/Runtime **provisional** | Still importable; may evolve under minors (see CHANGELOG) |
+| `cimport cypy` / `from cypy.cy* cimport …` | **Documented SDK** | Wider than Python; per-module **Surface** + inventory in [`docs/modules/`](docs/modules/) are authoritative |
+| Core names that are also `cpdef`/`cdef` | **Yes** | Same symbol, same semantics as public Core |
+| `cdef`-only helpers (builders, unique-ref fill, C-string keys, borrow pointers, …) | **Documented cimport** | Keep for Cython; never promote to pure-Python without a minor; demote/remove → major after advertise |
+| Soft letter/bare/`*_string` (post-0.3) | Implementation only | Not a public or cimport *product* contract; prefer word-prefix / `*_cstr` |
+
+**Authoritative lists:** `src/cypy/__init__.py` / `hot.py` `__all__`, `src/cypy/__init__.pxd` + `cy*.pxd`, tracker inventories.
+
+### Protocols (typed unknown)
+
+| Module | Prefer instead when typed | Notes |
+|--------|---------------------------|--------|
+| `cymapping` | `cydict` | `map_*` / `map_eq` — checks often win; prefer typed `dict_eq` |
+| `cysequence` | `cylist` / `cytuple` | `sq*` / `seq_eq` — prefer typed `list_eq`/`tuple_eq` |
+| `cynumber` | `cylong` / `cyfloat` / `cycomplex` / `cybool` | Binary ops often lose; prefer typed `long_eq` / `float_eq` / `complex_eq` / `bool_eq` when known; `num_eq` for protocol bridges |
+| `cyobject` | typed module above | Last resort attr/item/call bridges; `obj_eq` via RichCompareBool (not `hot`) |
+
+### Runtime (public and/or cimport)
+
+| Module | Surface | Notes |
+|--------|---------|--------|
+| `cydatetime`, `cycodecs`, `cymarshal`, `cyfileobject`, `cyweakref`, `cypycapsule`, `cycontextvars` | public (+ some cimport) | Higher-level C-API bridges; `dt_*_eq` / `capsule_eq` / `weakref_eq` / `context_eq` on `cypy` (not `hot`); see `docs/EQ_RUNTIME.md` |
+| `cytime` | public | Thin `time_wall` / `time_time` / `time_monotonic` / `time_perf_counter` — **Runtime**, not Core (`cypy.hot` excludes them). Prefer stdlib `time` unless you need these wrappers; prefer `time_wall` over stutter `time_time`. |
+| `cyfunction`, `cymethod`, `cymodule`, `cyiterator`, `cyiterobject`, `cygenobject`, `cycellobject`, `cydescr`, `cytype`, `cylong`, `cyfloat`, … | public | Object-model / scalar helpers; `func_eq` / `method_eq` / `mod_eq` / `gen_eq` / `iter_eq` / `type_eq` identity-or-richcompare / `cell_eq` content (not `hot`) |
+| `cyerr`, `cymem`, `cythread`, `cyatomic`, `cyref`, `cygetargs`, `cyceval`, `cypystate`, `cypylifecycle`, `cypyport`, `cyversion`, `cylongintrepr` | **cimport only** | Embedding / process footguns — not pure-Python |
+| `cyinstance` | **none** | Classic-class ABI gone on 3.14 |
+
+---
+
+## Import surfaces
+
+| Entry | Role |
+|-------|------|
+| `from cypy.hot import …` | **Core marketing surface** — micro-opt starters |
+| `import cypy` / `from cypy import …` | Full public barrel; Core discovery via `__all__` (frozen at 1.0) |
+| `from cypy.cydict import dget` | Module-scoped public |
+| `cimport cypy` / `from cypy.cydict cimport …` | **Full Cython SDK** (wider than Python; includes cimport-only) |
+
+Discourage `from cypy import *`.
+
+---
+
+## Overlap decision tree
+
+```
+Known concrete type?
+  dict  → cydict (dict_get, dict_len, …)
+  list  → cylist
+  tuple → cytuple
+  set   → cyset
+  bytes → cybytes
+  str   → cystr value ops; encode/intern → cyunicode
+Unknown mapping / sequence / number-like?
+  → cymapping / cysequence / cynumber
+Still too dynamic?
+  → cyobject (last resort)
+```
+
+**Do not merge modules** (C-API includes differ). Trackers already say “prefer typed when known.”
+
+**Playbook examples:** [`py_overlap_mapping_vs_dict.py`](examples/py_overlap_mapping_vs_dict.py),
+[`py_overlap_sequence_vs_list.py`](examples/py_overlap_sequence_vs_list.py),
+[`py_overlap_str_vs_unicode.py`](examples/py_overlap_str_vs_unicode.py).
+
+### String family (two layers, one product)
+
+| Layer | Module | Role |
+|-------|--------|------|
+| Value ops on `str` | `cystr` | len/eq/contains/concat/coerce/… |
+| Encode / intern / borrow | `cyunicode` | `uintern`, `uutf8_bytes`, cimport `unicode_from_string` / `uutf8` |
+
+### Naming conventions (N3 + N4)
+
+| Rule | Prefer | Notes |
+|------|--------|-------|
+| Checks | `{type}_check` / `{type}_check_exact` | Subtype vs exact; `str_is` ≡ `str_check_exact` |
+| Length | `*_len(typed)` vs `*_size(object)` | Macro/unchecked vs checked — **semantic twins**, never identity |
+
+Full table: [`docs/NAMING.md`](docs/NAMING.md). Removed soft aliases (0.3+): [`cypy.compat.COMPAT_MAP`](src/cypy/compat.py).
+
+### Category facades (optional discovery)
+
+| Import | Contents |
+|--------|----------|
+| `cypy.hot` | Micro-opt starters (preferred; **Core frozen**) |
+| `cypy.containers` | dict / list / set / tuple (Core-adjacent) |
+| `cypy.buffers` | bytes / bytearray / array / memoryview / buffer / slice |
+| `cypy.protocols` | mapping / sequence / number / object — **provisional** after 1.0 |
+
+---
+
+## Layers (implementation)
+
+| Layer | Entry | Role |
+|-------|--------|------|
+| Public Python | `__init__.py`, `hot.py` | Callable helpers |
+| Cython cimport | `__init__.pxd`, `cy*.pxd` | Wider SDK |
+| Implementation | `cy*.pxd` (+ `.pyx`) | Inline C-API wrappers |
+
+---
+
+## Not a goal
+
+- Full Cython `cpython.*` parity or full Python stdlib (`json`, `os`, `re`, `asyncio`, …)
+- Restoring builtin monkey-patches ([`docs/future/MONKEY.md`](docs/future/MONKEY.md))
+- Treating Protocol/Runtime losers as Core micro-opt defaults
+
+Historical note: an older tree lived as `cycel.core.cpy`. **`cytime` ships in cypy as Runtime** (not deferred to `cycel.time`). Broader clock/RFC utilities may still live in sibling packages.
+
+---
+
+## Related
+
+- Install / smoke: [`README.md`](README.md)
+- Safety / footguns: [`docs/SAFETY.md`](docs/SAFETY.md)
+- Naming: [`docs/NAMING.md`](docs/NAMING.md)
+- Compatibility / release: [`docs/RELEASE.md`](docs/RELEASE.md)
+- Trackers: [`docs/modules/`](docs/modules/) · Status (complete): [`docs/README.md`](docs/README.md#status-complete--not-an-open-backlog)

picop-1.44.16/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 ckirua
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

picop-1.44.16/LICENSES/Apache-2.0.txt

@@ -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.

picop-1.44.16/MANIFEST.in

@@ -0,0 +1,13 @@
+include README.md
+include COVERAGE.md
+include pyproject.toml
+include setup.py
+graft src
+graft examples
+graft docs
+prune examples/cimport_ext/build
+exclude examples/cimport_ext/demo.c
+global-exclude *.o
+global-exclude *.so *.pyc *.pyo
+global-exclude __pycache__
+global-exclude .git*

picop-1.44.16/NOTICE

@@ -0,0 +1,13 @@
+cypy
+
+Portions of cypy.uuid are adapted from the asyncpg project by
+MagicStack Inc. and contributors.
+
+Copyright (C) 2016-present the asyncpg authors and contributors
+
+The original asyncpg portions are licensed under the Apache License,
+Version 2.0. A copy is provided in LICENSES/Apache-2.0.txt.
+
+This attribution and the Apache License apply only to those adapted portions;
+they do not license cypy as a whole under Apache-2.0. cypy's primary license
+remains MIT as stated in LICENSE.

picop-1.44.16/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: picop
+Version: 1.44.16
+Summary: Fast CPython C-API helpers and C-backed UUID values for Cython
+Author-email: ckirua <aquipongoalgo.dsz@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/ckirua/cypy
+Project-URL: Repository, https://github.com/ckirua/cypy
+Project-URL: Issues, https://github.com/ckirua/cypy/issues
+Project-URL: Documentation, https://github.com/ckirua/cypy#readme
+Keywords: cython,cpython,c-api,performance,dict,str,bytes,uuid
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Cython
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSES/Apache-2.0.txt
+License-File: NOTICE
+Requires-Dist: Cython
+Requires-Dist: picobuild
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pyperf>=2.10.0; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# cypy
+
+Fast CPython C-API helpers for Cython — typed hot-path wrappers plus C-backed UUID values.
+
+Requires **Python ≥ 3.14**. Map of what is covered: [`COVERAGE.md`](COVERAGE.md). Primary license: [`LICENSE`](LICENSE) (MIT); adapted UUID portions retain their notices in [`NOTICE`](NOTICE) and [`LICENSES/Apache-2.0.txt`](LICENSES/Apache-2.0.txt). Contributing: [`CONTRIBUTING.md`](CONTRIBUTING.md). Security: [`SECURITY.md`](SECURITY.md). Safety / footguns: [`docs/SAFETY.md`](docs/SAFETY.md). Contributor process lives under [`docs/`](docs/) (not required for end users).
+
+## Install
+
+PyPI distribution name is **`picop`**; the import package remains **`cypy`**.
+
+### From PyPI
+
+```bash
+pip install picop
+# pin: pip install "picop==1.44.16"
+```
+
+Build deps (`setuptools`, `wheel`, `Cython`, `picobuild`) are pulled via `pyproject.toml` `[build-system]`. Source installs need a C toolchain and OpenSSL headers (`libssl-dev` on Debian/Ubuntu).
+
+### From git (users)
+
+```bash
+pip install "picop @ git+https://github.com/ckirua/cypy.git@v1.44.16"
+# or unpinned tip of main:
+# pip install "git+https://github.com/ckirua/cypy.git"
+```
+
+### Editable (contributors)
+
+```bash
+python3.14 -m venv .venv
+source .venv/bin/activate
+pip install setuptools wheel Cython picobuild
+pip install -e . --no-build-isolation
+```
+
+Release builds are **portable** by default (`-O3` only). For local microbenches that want CPU-tuned code:
+
+```bash
+CPY_NATIVE=1 pip install -e . --no-build-isolation
+```
+
+### Build artifacts
+
+```bash
+pip install build
+python -m build          # sdist + wheel under dist/
+# package_data ships .pxd / .pyi / py.typed / headers for cimport + typing
+```
+
+Optional typecheck smoke (after install):
+
+```bash
+# requires pyright or mypy
+pyright -c 'from cypy.hot import dict_get, list_append'  # or:
+python -c "from cypy.hot import dict_get, list_len; reveal_type = print"  # stubs via py.typed
+```
+
+## Smoke
+
+Prefer the curated starters module for micro-opts:
+
+```python
+from cypy.hot import bytes_len, dict_get, list_len, str_len
+
+assert bytes_len(b"ok") == 2
+assert str_len("hi") == 2
+assert dict_get({"a": 1}, "a") == 1
+assert list_len([1, 2]) == 2
+```
+
+Also supported: `from cypy.cydict import dict_get` / `from cypy import dict_get`, and Cython `cimport`. Soft letter/bare aliases were removed in **0.3** — use preferred names. Prefer a release-tag pin. Avoid `from cypy import *`.
+
+Cython: both **`from cypy cimport …`** (package barrel) and **`from cypy.cybytes cimport …`** (submodule) work after install. Out-of-tree regression: [`examples/cimport_ext/`](examples/cimport_ext/) / `bash scripts/smoke_barrel_cimport.sh`.
+
+Full public surface remains on `from cypy import …` / `cypy.cy*`.
+
+**Footgun:** C-string helpers take **`bytes`**, not `str`. Prefer `*_cstr` (`map_getitem_cstr`) — see `examples/py_cstr_bytes.py`. Broader trusted-caller notes (unchecked OOB, borrowed pointers, `marshal_loads`): [`docs/SAFETY.md`](docs/SAFETY.md).
+
+## UUID values
+
+`cypy.uuid` provides matching Python and Cython entry points:
+
+```python
+from cypy.uuid import UUID, uuid4, uuid4_bytes
+
+value = uuid4()
+raw = uuid4_bytes()
+assert UUID(raw).version == 4
+```
+
+```cython
+from cypy.uuid cimport UUID, uuid4, uuid4_bytes
+```
+
+The C-backed `UUID` is final, accepts 32–36 character hexadecimal text or
+exactly 16 bytes, and remains a stdlib-compatible `uuid.UUID` value. Generation
+uses per-thread buffered OpenSSL entropy with fork-child invalidation.
+
+## Examples
+
+Runnable scripts after install — see [`examples/README.md`](examples/README.md):
+
+```bash
+python examples/pyhot.py
+python examples/pybytes.py
+python examples/pydict.py
+```
+
+## Compatibility
+
+**1.0 policy:** **Core** (`cypy.__all__` + `cypy.hot`) and documented cimport contracts are frozen. Soft aliases were removed in **0.3**. Protocols / Runtime remain provisional under minors. See [`docs/RELEASE.md`](docs/RELEASE.md). Semantic twins like `dict_len`/`dict_size` stay dual (never identity-aliased). Prefer pin: `pip install "picop==1.44.16"`.
+
+Product tiers (Core / Protocols / Runtime): [`COVERAGE.md`](COVERAGE.md).
+
+## Benchmarks
+
+See [`bench/BENCH.md`](bench/BENCH.md). Quick Tier A run:
+
+```bash
+./bench/small.sh
+```
+
+## Docs
+
+| Doc | Audience |
+|-----|----------|
+| This README + [`examples/`](examples/) | External users |
+| [`COVERAGE.md`](COVERAGE.md) | What the library covers / does not (product map) |
+| [`CONTRIBUTING.md`](CONTRIBUTING.md) | Setup, checks, PR / freeze policy |
+| [`SECURITY.md`](SECURITY.md) | Vulnerability reporting |
+| [`docs/SAFETY.md`](docs/SAFETY.md) | Trusted-caller footguns |
+| [`docs/`](docs/) | Contributor pipeline, status, module trackers |
+
+Builtin monkey-patch experiments are **archived** under [`docs/future/MONKEY.md`](docs/future/MONKEY.md) and are **not** part of the package.