vbase-api 0.1.1__tar.gz → 0.1.3__tar.gz

vbase_api-0.1.3/MANIFEST.in

@@ -0,0 +1 @@
+include requirements.in

vbase_api-0.1.3/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: vbase-api
+Version: 0.1.3
+Summary: vBase REST API Python Client
+Author-email: vBase <tech@vbase.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/validityBase/vbase-api-py
+Project-URL: Documentation, https://docs.vbase.com/
+Keywords: vbase,stamping,web3,blockchain,validation
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+License-File: NOTICE.txt
+Requires-Dist: requests<3,>=2.7.0
+Dynamic: license-file
+
+# vbase-api-py
+
+vBase REST API Python Client
+
+See [documentation](https://docs.vbase.com/) and the [Swagger UI](https://app.vbase.com/swagger/) for more details.
+
+---
+
+## License
+
+This project is licensed under the Apache 2.0 License - see the [LICENSE.txt](LICENSE.txt) file for details.
+
+## Introduction
+
+vBase creates a global auditable record of when data was created, by whom, and how it has changed (collectively, “data provenance”). Data producers can prove the provenance of their data to any external party, increasing its value and marketability. Data consumers can ensure the integrity of historical data and any derivative calculations. The result is trustworthy information that can be put into production quickly without expensive and time-consuming trials.
+
+Verifiable provenance establishes the credibility of data and calculations. For example, if you wish to prove investment skill, the recipient must be sure they are receiving a complete and accurate record of your timestamped trades or portfolios.
+
+vBase resolves several expensive market failures common to financial data. Some of the areas that benefit include:
+- Provably point-in-time datasets
+- Auditable investing track records
+- Sound backtests, historical simulations, and time-series modeling
+
+vBase services do not require access to the data itself, assuring privacy. They also do not rely on centralized intermediaries, eliminating the technical, operating, and business risks of a trusted party controlling your data and its validation. vBase ensures data security and interoperability that is unattainable with legacy centralized systems. It does so by storing digital fingerprints of data, metadata, and revisions on secure public blockchains.
+
+With vBase, creating and consuming provably correct data is as easy as pressing a button.
+
+## References
+- [vBase Website](https://vbase.com)
+- [vBase Documentation](https://docs.vbase.com/)
+- [vBase Swagger UI](https://app.vbase.com/swagger/)
+- [vBase API Python Client Issues](https://github.com/validityBase/vbase-api-py/issues)
+
+## Installation
+
+Install the package using pip:
+
+```bash
+pip install vbase-api
+```
+
+## Quick Start
+
+### Getting Your API Key
+
+To use the vBase API, you'll need an API key (Bearer token). You can obtain this from your [vBase account settings](https://app.vbase.com/profile#account_settings).
+
+### Basic Usage
+
+```python
+from vbase_api import VBaseAPIClient
+
+# Initialize the client
+client = VBaseAPIClient(api_key="your-bearer-token")
+
+# Stamp some data
+stamp = client.create_stamp(data="Important data to be stamped")
+print(f"Stamped with CID: {stamp.commitment_receipt.object_cid}")
+
+# List your collections
+collections = client.get_collections()
+for collection in collections:
+    print(f"{collection.name}: {collection.cid}")
+```
+
+

vbase_api-0.1.3/README.md

@@ -0,0 +1,66 @@
+# vbase-api-py
+
+vBase REST API Python Client
+
+See [documentation](https://docs.vbase.com/) and the [Swagger UI](https://app.vbase.com/swagger/) for more details.
+
+---
+
+## License
+
+This project is licensed under the Apache 2.0 License - see the [LICENSE.txt](LICENSE.txt) file for details.
+
+## Introduction
+
+vBase creates a global auditable record of when data was created, by whom, and how it has changed (collectively, “data provenance”). Data producers can prove the provenance of their data to any external party, increasing its value and marketability. Data consumers can ensure the integrity of historical data and any derivative calculations. The result is trustworthy information that can be put into production quickly without expensive and time-consuming trials.
+
+Verifiable provenance establishes the credibility of data and calculations. For example, if you wish to prove investment skill, the recipient must be sure they are receiving a complete and accurate record of your timestamped trades or portfolios.
+
+vBase resolves several expensive market failures common to financial data. Some of the areas that benefit include:
+- Provably point-in-time datasets
+- Auditable investing track records
+- Sound backtests, historical simulations, and time-series modeling
+
+vBase services do not require access to the data itself, assuring privacy. They also do not rely on centralized intermediaries, eliminating the technical, operating, and business risks of a trusted party controlling your data and its validation. vBase ensures data security and interoperability that is unattainable with legacy centralized systems. It does so by storing digital fingerprints of data, metadata, and revisions on secure public blockchains.
+
+With vBase, creating and consuming provably correct data is as easy as pressing a button.
+
+## References
+- [vBase Website](https://vbase.com)
+- [vBase Documentation](https://docs.vbase.com/)
+- [vBase Swagger UI](https://app.vbase.com/swagger/)
+- [vBase API Python Client Issues](https://github.com/validityBase/vbase-api-py/issues)
+
+## Installation
+
+Install the package using pip:
+
+```bash
+pip install vbase-api
+```
+
+## Quick Start
+
+### Getting Your API Key
+
+To use the vBase API, you'll need an API key (Bearer token). You can obtain this from your [vBase account settings](https://app.vbase.com/profile#account_settings).
+
+### Basic Usage
+
+```python
+from vbase_api import VBaseAPIClient
+
+# Initialize the client
+client = VBaseAPIClient(api_key="your-bearer-token")
+
+# Stamp some data
+stamp = client.create_stamp(data="Important data to be stamped")
+print(f"Stamped with CID: {stamp.commitment_receipt.object_cid}")
+
+# List your collections
+collections = client.get_collections()
+for collection in collections:
+    print(f"{collection.name}: {collection.cid}")
+```
+
+

{vbase_api-0.1.1 → vbase_api-0.1.3}/pyproject.toml

@@ -1,36 +1,35 @@
-[build-system]
-requires = ["setuptools >= 77.0.3"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "vbase-api"          # This is the name on PyPI
-version = "0.1.1"            # Must match __version__ above for now
-description = "vBase REST API Python Client"
-readme = "README.md"
-requires-python = ">=3.8"
-dependencies = [
-  "requests>=2.7.0"
-]
-license = "Apache-2.0"
-authors = [
-  { name = "vBase", email = "tech@vbase.com" }
-]
-
-keywords = ["vbase", "stamping", "web3", "blockchain", "validation"]
-classifiers = [
-  "Programming Language :: Python :: 3",
-  "Operating System :: OS Independent",
-]
-
-[project.urls]
-Homepage = "https://github.com/validityBase/vbase-api-py"
-Documentation = "https://docs.vbase.com/"
-
-# This tells setuptools where to find the code
-[tool.setuptools]
-package-dir = {"" = "src"}
-
-[tool.setuptools.packages.find]
-
-where = ["src"]
-
+[build-system]
+requires = ["setuptools >= 77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vbase-api"          # This is the name on PyPI
+dynamic = ["version", "dependencies"]
+description = "vBase REST API Python Client"
+readme = "README.md"
+requires-python = ">=3.8"
+license = "Apache-2.0"
+authors = [
+  { name = "vBase", email = "tech@vbase.com" }
+]
+
+keywords = ["vbase", "stamping", "web3", "blockchain", "validation"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/validityBase/vbase-api-py"
+Documentation = "https://docs.vbase.com/"
+
+# This tells setuptools where to find the code
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.dynamic]
+version = {attr = "vbase_api._version.__version__"}
+dependencies = {file = ["requirements.in"]}

vbase_api-0.1.3/requirements.in

@@ -0,0 +1 @@
+requests>=2.7.0,<3

{vbase_api-0.1.1 → vbase_api-0.1.3}/src/vbase_api/__init__.py

@@ -1,5 +1,6 @@
 # src/simplemath/__init__.py
 
+from ._version import __version__
 from .vbase_api_client import VBaseAPIError, VBaseAPIClient
 from .vbase_api_models import (
     Collection,
@@ -10,6 +11,7 @@ from .vbase_api_models import (
 )
 
 __all__ = [
+    "__version__",
     "VBaseAPIClient",
     "VBaseAPIError",
     "Collection",

vbase_api-0.1.3/src/vbase_api/_version.py

@@ -0,0 +1 @@
+__version__ = "0.1.3"

{vbase_api-0.1.1 → vbase_api-0.1.3}/src/vbase_api/vbase_api_client.py

@@ -13,6 +13,7 @@ import requests
 from pathlib import Path
 from typing import Dict, List, Optional, Any, BinaryIO, Union
 
+from ._version import __version__
 from .vbase_api_models import (
     Collection,
     StampCreatedResponse,
@@ -48,9 +49,11 @@ class VBaseAPIClient:
         timeout: Request timeout in seconds (default: 30)
 
     Example:
-        >>> client = VBaseAPIClient(api_key="your-bearer-token")
-        >>> collections = client.list_collections()
-        >>> stamp = client.create_stamp(data={"hello": "world"})
+        .. code-block:: python
+
+            client = VBaseAPIClient(api_key="your-bearer-token")
+            collections = client.list_collections()
+            stamp = client.create_stamp(data={"hello": "world"})
     """
 
     DEFAULT_BASE_URL = "https://app.vbase.com"
@@ -69,6 +72,7 @@ class VBaseAPIClient:
         self.session = requests.Session()
         self.session.headers.update({
             'Authorization': f'Bearer {api_key}',
+            'User-Agent': f'vBase API Python Client v{__version__}',
         })
 
     def _get_url(self, endpoint: str) -> str:
@@ -144,9 +148,11 @@ class VBaseAPIClient:
             VBaseAPIError: If the request fails
 
         Example:
-            >>> collections = client.get_collections(is_pinned=True)
-            >>> for collection in collections:
-            ...     print(f"{collection.name}: {collection.cid}")
+            .. code-block:: python
+
+                collections = client.get_collections(is_pinned=True)
+                for collection in collections:
+                    print(f"{collection.name}: {collection.cid}")
         """
         params = {}
         if user_address is not None:
@@ -185,13 +191,15 @@ class VBaseAPIClient:
             VBaseAPIError: If the request fails or collection already exists
 
         Example:
-            >>> collection = client.create_collection(
-            ...     name="My Collection",
-            ...     cid="0x1234567890abcdef...",
-            ...     description="A sample collection",
-            ...     is_pinned=True
-            ... )
-            >>> print(f"Created: {collection.name}")
+            .. code-block:: python
+
+                collection = client.create_collection(
+                    name="My Collection",
+                    cid="0x1234567890abcdef...",
+                    description="A sample collection",
+                    is_pinned=True
+                )
+                print(f"Created: {collection.name}")
         """
         data = {
             'name': name,
@@ -250,17 +258,19 @@ class VBaseAPIClient:
             ValueError: If invalid parameters are provided
         
         Example:
-            >>> # Stamp inline data
-            >>> stamp = client.create_stamp(data={"hello": "world"})
-            >>> print(f"Object CID: {stamp.commitment_receipt.object_cid}")
-            
-            >>> # Stamp a file
-            >>> stamp = client.create_stamp(file="document.pdf", collection_name="Documents")
-            >>> if stamp.file_object:
-            ...     print(f"File: {stamp.file_object.file_name}")
-            
-            >>> # Stamp an existing CID
-            >>> stamp = client.create_stamp(data_cid="Qm...")
+            .. code-block:: python
+
+                # Stamp inline data
+                stamp = client.create_stamp(data={"hello": "world"})
+                print(f"Object CID: {stamp.commitment_receipt.object_cid}")
+
+                # Stamp a file
+                stamp = client.create_stamp(file="document.pdf", collection_name="Documents")
+                if stamp.file_object:
+                    print(f"File: {stamp.file_object.file_name}")
+
+                # Stamp an existing CID
+                stamp = client.create_stamp(data_cid="Qm...")
         """
         if not any([file, data, data_cid]):
             raise ValueError("At least one of 'file', 'data', or 'data_cid' must be provided")
@@ -335,11 +345,13 @@ class VBaseAPIClient:
             VBaseAPIError: If validation fails or file not found in blockchain
 
         Example:
-            >>> result = client.upload_stamped_file(
-            ...     collection_name="My Collection",
-            ...     file="stamped_document.pdf"
-            ... )
-            >>> print(f"Uploaded: {result.file_object.file_name}")
+            .. code-block:: python
+
+                result = client.upload_stamped_file(
+                    collection_name="My Collection",
+                    file="stamped_document.pdf"
+                )
+                print(f"Uploaded: {result.file_object.file_name}")
         """
         form_data = {
             'collection_name': collection_name
@@ -384,12 +396,14 @@ class VBaseAPIClient:
             VBaseAPIError: If the request fails
 
         Example:
-            >>> result = client.verify_stamps(
-            ...     cids=["0xbd...1", "0xcd...2"],
-            ...     filter_by_user=True
-            ... )
-            >>> for stamp in result.stamp_list:
-            ...     print(f"Found stamp at {stamp.timestamp}")
+            .. code-block:: python
+
+                result = client.verify_stamps(
+                    cids=["0xbd...1", "0xcd...2"],
+                    filter_by_user=True
+                )
+                for stamp in result.stamp_list:
+                    print(f"Found stamp at {stamp.timestamp}")
         """
         data = {
             'cids': cids,
@@ -419,8 +433,10 @@ class VBaseAPIClient:
             VBaseAPIError: If the request fails
 
         Example:
-            >>> user = client.get_current_user()
-            >>> print(f"User email: {user.email}")
+            .. code-block:: python
+
+                user = client.get_current_user()
+                print(f"User email: {user.email}")
         """
         response = self.session.get(
             self._get_url('users/me'),
@@ -443,8 +459,10 @@ class VBaseAPIClient:
             VBaseAPIError: If the request fails or user not found
         
         Example:
-            >>> user = client.get_user("0x...")
-            >>> print(f"User name: {user.name}")
+            .. code-block:: python
+
+                user = client.get_user("0x...")
+                print(f"User name: {user.name}")
         """
         response = self.session.get(
             self._get_url(f'users/{user_address}'),
@@ -484,7 +502,9 @@ def create_client(
         Configured VBaseAPIClient instance
 
     Example:
-        >>> client = create_client(api_key="your-bearer-token")
-        >>> collections = client.get_collections()
+        .. code-block:: python
+
+            client = create_client(api_key="your-bearer-token")
+            collections = client.get_collections()
     """
     return VBaseAPIClient(api_key=api_key, base_url=base_url, timeout=timeout)

vbase_api-0.1.3/src/vbase_api.egg-info/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: vbase-api
+Version: 0.1.3
+Summary: vBase REST API Python Client
+Author-email: vBase <tech@vbase.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/validityBase/vbase-api-py
+Project-URL: Documentation, https://docs.vbase.com/
+Keywords: vbase,stamping,web3,blockchain,validation
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+License-File: NOTICE.txt
+Requires-Dist: requests<3,>=2.7.0
+Dynamic: license-file
+
+# vbase-api-py
+
+vBase REST API Python Client
+
+See [documentation](https://docs.vbase.com/) and the [Swagger UI](https://app.vbase.com/swagger/) for more details.
+
+---
+
+## License
+
+This project is licensed under the Apache 2.0 License - see the [LICENSE.txt](LICENSE.txt) file for details.
+
+## Introduction
+
+vBase creates a global auditable record of when data was created, by whom, and how it has changed (collectively, “data provenance”). Data producers can prove the provenance of their data to any external party, increasing its value and marketability. Data consumers can ensure the integrity of historical data and any derivative calculations. The result is trustworthy information that can be put into production quickly without expensive and time-consuming trials.
+
+Verifiable provenance establishes the credibility of data and calculations. For example, if you wish to prove investment skill, the recipient must be sure they are receiving a complete and accurate record of your timestamped trades or portfolios.
+
+vBase resolves several expensive market failures common to financial data. Some of the areas that benefit include:
+- Provably point-in-time datasets
+- Auditable investing track records
+- Sound backtests, historical simulations, and time-series modeling
+
+vBase services do not require access to the data itself, assuring privacy. They also do not rely on centralized intermediaries, eliminating the technical, operating, and business risks of a trusted party controlling your data and its validation. vBase ensures data security and interoperability that is unattainable with legacy centralized systems. It does so by storing digital fingerprints of data, metadata, and revisions on secure public blockchains.
+
+With vBase, creating and consuming provably correct data is as easy as pressing a button.
+
+## References
+- [vBase Website](https://vbase.com)
+- [vBase Documentation](https://docs.vbase.com/)
+- [vBase Swagger UI](https://app.vbase.com/swagger/)
+- [vBase API Python Client Issues](https://github.com/validityBase/vbase-api-py/issues)
+
+## Installation
+
+Install the package using pip:
+
+```bash
+pip install vbase-api
+```
+
+## Quick Start
+
+### Getting Your API Key
+
+To use the vBase API, you'll need an API key (Bearer token). You can obtain this from your [vBase account settings](https://app.vbase.com/profile#account_settings).
+
+### Basic Usage
+
+```python
+from vbase_api import VBaseAPIClient
+
+# Initialize the client
+client = VBaseAPIClient(api_key="your-bearer-token")
+
+# Stamp some data
+stamp = client.create_stamp(data="Important data to be stamped")
+print(f"Stamped with CID: {stamp.commitment_receipt.object_cid}")
+
+# List your collections
+collections = client.get_collections()
+for collection in collections:
+    print(f"{collection.name}: {collection.cid}")
+```
+
+

{vbase_api-0.1.1 → vbase_api-0.1.3}/src/vbase_api.egg-info/SOURCES.txt

@@ -1,12 +1,16 @@
 LICENSE.txt
+MANIFEST.in
 NOTICE.txt
 README.md
 pyproject.toml
+requirements.in
 src/vbase_api/__init__.py
+src/vbase_api/_version.py
 src/vbase_api/vbase_api_client.py
 src/vbase_api/vbase_api_models.py
 src/vbase_api.egg-info/PKG-INFO
 src/vbase_api.egg-info/SOURCES.txt
 src/vbase_api.egg-info/dependency_links.txt
 src/vbase_api.egg-info/requires.txt
-src/vbase_api.egg-info/top_level.txt
+src/vbase_api.egg-info/top_level.txt
+tests/test_file_integrity_e2e.py

vbase_api-0.1.3/src/vbase_api.egg-info/requires.txt

@@ -0,0 +1 @@
+requests<3,>=2.7.0