opteryx-catalog 0.3.1__tar.gz

opteryx_catalog-0.3.1/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 2025 Justin Joyce (@joocer)
+
+   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.

opteryx_catalog-0.3.1/PKG-INFO

@@ -0,0 +1,253 @@
+Metadata-Version: 2.4
+Name: opteryx_catalog
+Version: 0.3.1
+Summary: Opteryx Cloud Catalog
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: google-cloud-firestore==2.22.0
+Requires-Dist: google-cloud-storage==3.7.0
+Requires-Dist: orso==0.0.226
+Requires-Dist: opteryx-core
+Requires-Dist: pyarrow==22.0.0
+Requires-Dist: pyiceberg==0.10.0
+Requires-Dist: requests==2.32.5
+Dynamic: license-file
+
+# pyiceberg-firestore-gcs
+
+A Firestore + Google Cloud Storage (GCS) backed implementation of the PyIceberg
+catalog interface. This package provides a straightforward, opinionated
+catalog implementation for storing table metadata documents in Firestore while
+storing the Iceberg table metadata JSON in GCS.
+
+This project is intended to be used as a catalog component for PyIceberg in
+GCP-based environments.
+
+---
+
+## Features ✅
+
+- Firestore-backed catalog and namespace storage
+- GCS-based Iceberg table metadata storage (with optional compatibility mode)
+ - GCS-based table metadata storage; export/import utilities provide Iceberg Avro interoperability
+- Table creation, registration, listing, loading, renaming, and deletion
+- Commit operations that write updated metadata to GCS and persist references in Firestore
+- Simple, opinionated defaults (e.g., default GCS location derived from catalog properties)
+- Lightweight schema handling compatible with PyIceberg (supports pyarrow schemas and PyIceberg Schema)
+
+## Quick start 💡
+
+1. Ensure you have GCP credentials available to the environment. Typical approaches:
+   - Set `GOOGLE_APPLICATION_CREDENTIALS` to a service account JSON key file, or
+   - Use `gcloud auth application-default login` for local development.
+
+2. Install locally (or publish to your package repo):
+
+```bash
+python -m pip install -e .
+```
+
+3. Create a `FirestoreCatalog` and use it in your application:
+
+```python
+from pyiceberg_firestore_gcs import create_catalog
+from pyiceberg.schema import Schema, NestedField
+from pyiceberg.types import IntegerType, StringType
+
+catalog = create_catalog(
+	"my_catalog",
+	firestore_project="my-gcp-project",
+	gcs_bucket="my-default-bucket",
+)
+
+# Create a namespace
+catalog.create_namespace("example_namespace")
+
+# Create a simple PyIceberg schema
+schema = Schema(
+	NestedField(field_id=1, name="id", field_type=IntegerType(), required=True),
+	NestedField(field_id=2, name="name", field_type=StringType(), required=False),
+)
+
+# Create a new table (metadata written to a GCS path derived from the bucket property)
+table = catalog.create_table(("example_namespace", "users"), schema)
+
+# Or register a table if you already have a metadata JSON in GCS
+catalog.register_table(("example_namespace", "events"), "gs://my-bucket/path/to/events/metadata/00000001.json")
+
+# Load a table
+tbl = catalog.load_table(("example_namespace", "users"))
+print(tbl.metadata)
+```
+
+## Configuration and environment 🔧
+
+- GCP authentication: Use `GOOGLE_APPLICATION_CREDENTIALS` or Application Default Credentials
+- `firestore_project` and `firestore_database` can be supplied when creating the catalog
+- `gcs_bucket` is recommended to allow `create_table` to write metadata automatically; otherwise pass `location` explicitly to `create_table`
+ - The catalog does not write Iceberg Avro/manifest-list artifacts in the hot path; use `export_to_iceberg` / `import_from_iceberg` for interoperability
+
+Example environment variables:
+
+```bash
+export GOOGLE_APPLICATION_CREDENTIALS="/path/to/service-account.json"
+export GOOGLE_CLOUD_PROJECT="my-gcp-project"
+```
+
+### Iceberg interoperability
+
+This catalog implementation does not write Iceberg Avro manifest-list/Avro manifest files
+or Iceberg metadata JSON in the hot path. Instead, table metadata is stored in Firestore and
+the runtime writes a consolidated Parquet manifest for fast query planning.
+
+If you need full Iceberg-compatible artifacts for other engines or tools, use the
+`export_to_iceberg` utility to generate Avro manifests and manifest-lists from
+the Parquet-first storage layout. To ingest existing Iceberg Avro artifacts into this
+catalog, use `import_from_iceberg` which will convert Avro manifests into the
+Parquet manifest + Firestore snapshot representation used here.
+
+## API overview 📚
+
+The package exports a factory helper `create_catalog` and the `FirestoreCatalog` class.
+
+Key methods include:
+- `create_namespace(namespace, properties={}, exists_ok=False)`
+- `drop_namespace(namespace)`
+- `list_namespaces()`
+- `create_table(identifier, schema, location=None, partition_spec=None, sort_order=None, properties={})`
+- `register_table(identifier, metadata_location)`
+- `load_table(identifier)`
+- `list_tables(namespace)`
+- `drop_table(identifier)`
+- `rename_table(from_identifier, to_identifier)`
+- `commit_table(table, requirements, updates)`
+- `create_view(identifier, sql, schema=None, author=None, description=None, properties={})`
+- `load_view(identifier)`
+- `list_views(namespace)`
+- `view_exists(identifier)`
+- `drop_view(identifier)`
+- `update_view_execution_metadata(identifier, row_count=None, execution_time=None)`
+
+### Views 👁️
+
+Views are SQL queries stored in the catalog that can be referenced like tables. Each view includes:
+- **SQL statement**: The query that defines the view
+- **Schema**: The expected result schema (optional but recommended)
+- **Metadata**: Author, description, creation/update timestamps
+- **Execution history**: Last run time, row count, execution time
+
+Example usage:
+```python
+from pyiceberg.schema import Schema, NestedField
+from pyiceberg.types import IntegerType, StringType
+
+# Create a schema for the view
+schema = Schema(
+    NestedField(field_id=1, name="user_id", field_type=IntegerType(), required=True),
+    NestedField(field_id=2, name="username", field_type=StringType(), required=False),
+)
+
+# Create a view
+view = catalog.create_view(
+    identifier=("my_namespace", "active_users"),
+    sql="SELECT user_id, username FROM users WHERE active = true",
+    schema=schema,
+    author="data_team",
+    description="View of all active users in the system"
+)
+
+# Load a view
+view = catalog.load_view(("my_namespace", "active_users"))
+print(f"SQL: {view.sql}")
+print(f"Schema: {view.metadata.schema}")
+
+# Update execution metadata after running the view
+catalog.update_view_execution_metadata(
+    ("my_namespace", "active_users"),
+    row_count=1250,
+    execution_time=0.45
+)
+```
+
+Notes about behavior:
+- `create_table` will try to infer a default GCS location using the provided `gcs_bucket` property if `location` is omitted.
+- `register_table` validates that the provided `metadata_location` points to an existing GCS blob.
+- Views are stored as Firestore documents with complete metadata including SQL, schema, authorship, and execution history.
+- Table transactions are intentionally unimplemented.
+
+## Development & Linting 🧪
+
+This package includes a small `Makefile` target to run linting and formatting tools (`ruff`, `isort`, `pycln`).
+
+Install dev tools and run linters with:
+
+```bash
+python -m pip install --upgrade pycln isort ruff
+make lint
+```
+
+Running tests (if you add tests):
+
+```bash
+python -m pytest
+```
+
+## Compaction 🔧
+
+This catalog supports small file compaction to improve query performance. See [COMPACTION.md](COMPACTION.md) for detailed design documentation.
+
+### Quick Start
+
+```python
+from pyiceberg_firestore_gcs import create_catalog
+from pyiceberg_firestore_gcs.compaction import compact_table, get_compaction_stats
+
+catalog = create_catalog(...)
+
+# Check if compaction is needed
+table = catalog.load_table(("namespace", "table_name"))
+stats = get_compaction_stats(table)
+print(f"Small files: {stats['small_file_count']}")
+
+# Run compaction
+result = compact_table(catalog, ("namespace", "table_name"))
+print(f"Compacted {result.files_rewritten} files")
+```
+
+### Configuration
+
+Control compaction behavior via table properties:
+
+```python
+table = catalog.create_table(
+    identifier=("namespace", "table_name"),
+    schema=schema,
+    properties={
+        "compaction.enabled": "true",
+        "compaction.min-file-count": "10",
+        "compaction.max-small-file-size-bytes": "33554432",  # 32 MB
+        "write.target-file-size-bytes": "134217728"  # 128 MB
+    }
+)
+```
+
+## Limitations & KNOWN ISSUES ⚠️
+
+- No support for table-level transactions. `create_table_transaction` raises `NotImplementedError`.
+- The catalog stores metadata location references in Firestore; purging metadata files from GCS is not implemented.
+- This is an opinionated implementation intended for internal or controlled environments. Review for production constraints before use in multi-tenant environments.
+
+## Contributing 🤝
+
+Contributions are welcome. Please follow these steps:
+
+1. Fork the repository and create a feature branch.
+2. Run and pass linting and tests locally.
+3. Submit a PR with a clear description of the change.
+
+Please add unit tests and docs for new behaviors.
+
+---
+
+If you'd like, I can also add usage examples that show inserting rows using PyIceberg readers/writers, or add CI testing steps to the repository. ✅

opteryx_catalog-0.3.1/README.md

@@ -0,0 +1,237 @@
+# pyiceberg-firestore-gcs
+
+A Firestore + Google Cloud Storage (GCS) backed implementation of the PyIceberg
+catalog interface. This package provides a straightforward, opinionated
+catalog implementation for storing table metadata documents in Firestore while
+storing the Iceberg table metadata JSON in GCS.
+
+This project is intended to be used as a catalog component for PyIceberg in
+GCP-based environments.
+
+---
+
+## Features ✅
+
+- Firestore-backed catalog and namespace storage
+- GCS-based Iceberg table metadata storage (with optional compatibility mode)
+ - GCS-based table metadata storage; export/import utilities provide Iceberg Avro interoperability
+- Table creation, registration, listing, loading, renaming, and deletion
+- Commit operations that write updated metadata to GCS and persist references in Firestore
+- Simple, opinionated defaults (e.g., default GCS location derived from catalog properties)
+- Lightweight schema handling compatible with PyIceberg (supports pyarrow schemas and PyIceberg Schema)
+
+## Quick start 💡
+
+1. Ensure you have GCP credentials available to the environment. Typical approaches:
+   - Set `GOOGLE_APPLICATION_CREDENTIALS` to a service account JSON key file, or
+   - Use `gcloud auth application-default login` for local development.
+
+2. Install locally (or publish to your package repo):
+
+```bash
+python -m pip install -e .
+```
+
+3. Create a `FirestoreCatalog` and use it in your application:
+
+```python
+from pyiceberg_firestore_gcs import create_catalog
+from pyiceberg.schema import Schema, NestedField
+from pyiceberg.types import IntegerType, StringType
+
+catalog = create_catalog(
+	"my_catalog",
+	firestore_project="my-gcp-project",
+	gcs_bucket="my-default-bucket",
+)
+
+# Create a namespace
+catalog.create_namespace("example_namespace")
+
+# Create a simple PyIceberg schema
+schema = Schema(
+	NestedField(field_id=1, name="id", field_type=IntegerType(), required=True),
+	NestedField(field_id=2, name="name", field_type=StringType(), required=False),
+)
+
+# Create a new table (metadata written to a GCS path derived from the bucket property)
+table = catalog.create_table(("example_namespace", "users"), schema)
+
+# Or register a table if you already have a metadata JSON in GCS
+catalog.register_table(("example_namespace", "events"), "gs://my-bucket/path/to/events/metadata/00000001.json")
+
+# Load a table
+tbl = catalog.load_table(("example_namespace", "users"))
+print(tbl.metadata)
+```
+
+## Configuration and environment 🔧
+
+- GCP authentication: Use `GOOGLE_APPLICATION_CREDENTIALS` or Application Default Credentials
+- `firestore_project` and `firestore_database` can be supplied when creating the catalog
+- `gcs_bucket` is recommended to allow `create_table` to write metadata automatically; otherwise pass `location` explicitly to `create_table`
+ - The catalog does not write Iceberg Avro/manifest-list artifacts in the hot path; use `export_to_iceberg` / `import_from_iceberg` for interoperability
+
+Example environment variables:
+
+```bash
+export GOOGLE_APPLICATION_CREDENTIALS="/path/to/service-account.json"
+export GOOGLE_CLOUD_PROJECT="my-gcp-project"
+```
+
+### Iceberg interoperability
+
+This catalog implementation does not write Iceberg Avro manifest-list/Avro manifest files
+or Iceberg metadata JSON in the hot path. Instead, table metadata is stored in Firestore and
+the runtime writes a consolidated Parquet manifest for fast query planning.
+
+If you need full Iceberg-compatible artifacts for other engines or tools, use the
+`export_to_iceberg` utility to generate Avro manifests and manifest-lists from
+the Parquet-first storage layout. To ingest existing Iceberg Avro artifacts into this
+catalog, use `import_from_iceberg` which will convert Avro manifests into the
+Parquet manifest + Firestore snapshot representation used here.
+
+## API overview 📚
+
+The package exports a factory helper `create_catalog` and the `FirestoreCatalog` class.
+
+Key methods include:
+- `create_namespace(namespace, properties={}, exists_ok=False)`
+- `drop_namespace(namespace)`
+- `list_namespaces()`
+- `create_table(identifier, schema, location=None, partition_spec=None, sort_order=None, properties={})`
+- `register_table(identifier, metadata_location)`
+- `load_table(identifier)`
+- `list_tables(namespace)`
+- `drop_table(identifier)`
+- `rename_table(from_identifier, to_identifier)`
+- `commit_table(table, requirements, updates)`
+- `create_view(identifier, sql, schema=None, author=None, description=None, properties={})`
+- `load_view(identifier)`
+- `list_views(namespace)`
+- `view_exists(identifier)`
+- `drop_view(identifier)`
+- `update_view_execution_metadata(identifier, row_count=None, execution_time=None)`
+
+### Views 👁️
+
+Views are SQL queries stored in the catalog that can be referenced like tables. Each view includes:
+- **SQL statement**: The query that defines the view
+- **Schema**: The expected result schema (optional but recommended)
+- **Metadata**: Author, description, creation/update timestamps
+- **Execution history**: Last run time, row count, execution time
+
+Example usage:
+```python
+from pyiceberg.schema import Schema, NestedField
+from pyiceberg.types import IntegerType, StringType
+
+# Create a schema for the view
+schema = Schema(
+    NestedField(field_id=1, name="user_id", field_type=IntegerType(), required=True),
+    NestedField(field_id=2, name="username", field_type=StringType(), required=False),
+)
+
+# Create a view
+view = catalog.create_view(
+    identifier=("my_namespace", "active_users"),
+    sql="SELECT user_id, username FROM users WHERE active = true",
+    schema=schema,
+    author="data_team",
+    description="View of all active users in the system"
+)
+
+# Load a view
+view = catalog.load_view(("my_namespace", "active_users"))
+print(f"SQL: {view.sql}")
+print(f"Schema: {view.metadata.schema}")
+
+# Update execution metadata after running the view
+catalog.update_view_execution_metadata(
+    ("my_namespace", "active_users"),
+    row_count=1250,
+    execution_time=0.45
+)
+```
+
+Notes about behavior:
+- `create_table` will try to infer a default GCS location using the provided `gcs_bucket` property if `location` is omitted.
+- `register_table` validates that the provided `metadata_location` points to an existing GCS blob.
+- Views are stored as Firestore documents with complete metadata including SQL, schema, authorship, and execution history.
+- Table transactions are intentionally unimplemented.
+
+## Development & Linting 🧪
+
+This package includes a small `Makefile` target to run linting and formatting tools (`ruff`, `isort`, `pycln`).
+
+Install dev tools and run linters with:
+
+```bash
+python -m pip install --upgrade pycln isort ruff
+make lint
+```
+
+Running tests (if you add tests):
+
+```bash
+python -m pytest
+```
+
+## Compaction 🔧
+
+This catalog supports small file compaction to improve query performance. See [COMPACTION.md](COMPACTION.md) for detailed design documentation.
+
+### Quick Start
+
+```python
+from pyiceberg_firestore_gcs import create_catalog
+from pyiceberg_firestore_gcs.compaction import compact_table, get_compaction_stats
+
+catalog = create_catalog(...)
+
+# Check if compaction is needed
+table = catalog.load_table(("namespace", "table_name"))
+stats = get_compaction_stats(table)
+print(f"Small files: {stats['small_file_count']}")
+
+# Run compaction
+result = compact_table(catalog, ("namespace", "table_name"))
+print(f"Compacted {result.files_rewritten} files")
+```
+
+### Configuration
+
+Control compaction behavior via table properties:
+
+```python
+table = catalog.create_table(
+    identifier=("namespace", "table_name"),
+    schema=schema,
+    properties={
+        "compaction.enabled": "true",
+        "compaction.min-file-count": "10",
+        "compaction.max-small-file-size-bytes": "33554432",  # 32 MB
+        "write.target-file-size-bytes": "134217728"  # 128 MB
+    }
+)
+```
+
+## Limitations & KNOWN ISSUES ⚠️
+
+- No support for table-level transactions. `create_table_transaction` raises `NotImplementedError`.
+- The catalog stores metadata location references in Firestore; purging metadata files from GCS is not implemented.
+- This is an opinionated implementation intended for internal or controlled environments. Review for production constraints before use in multi-tenant environments.
+
+## Contributing 🤝
+
+Contributions are welcome. Please follow these steps:
+
+1. Fork the repository and create a feature branch.
+2. Run and pass linting and tests locally.
+3. Submit a PR with a clear description of the change.
+
+Please add unit tests and docs for new behaviors.
+
+---
+
+If you'd like, I can also add usage examples that show inserting rows using PyIceberg readers/writers, or add CI testing steps to the repository. ✅