aracnid-core 0.1.3__tar.gz

aracnid_core-0.1.3/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jason Romano
+
+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.

aracnid_core-0.1.3/PKG-INFO

@@ -0,0 +1,60 @@
+Metadata-Version: 2.3
+Name: aracnid-core
+Version: 0.1.3
+Summary: Base interfaces for Aracnid integration connectors
+License: MIT
+Keywords: abstract,connector
+Author: Jason Romano
+Author-email: aracnid@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Project-URL: Repository, https://github.com/aracnid/aracnid-core
+Description-Content-Type: text/markdown
+
+# Aracnid Core
+
+This package provides abstract interfaces and shared types for building Aracnid-compatible data connectors.
+
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
+
+### Prerequisites
+
+This package supports the following version of Python:
+
+- Python 3.10 or later
+
+### Installing
+
+Install the latest package using pip. (We prefer poetry.)
+
+```
+$ poetry install aracnid-core
+```
+
+## Running the tests
+
+Explain how to run the automated tests for this system
+
+```
+$ python -m pytest
+```
+
+## Usage
+
+TODO
+
+## Authors
+
+- **Jason Romano** - [Aracnid](https://github.com/aracnid)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
+

aracnid_core-0.1.3/README.md

@@ -0,0 +1,41 @@
+# Aracnid Core
+
+This package provides abstract interfaces and shared types for building Aracnid-compatible data connectors.
+
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
+
+### Prerequisites
+
+This package supports the following version of Python:
+
+- Python 3.10 or later
+
+### Installing
+
+Install the latest package using pip. (We prefer poetry.)
+
+```
+$ poetry install aracnid-core
+```
+
+## Running the tests
+
+Explain how to run the automated tests for this system
+
+```
+$ python -m pytest
+```
+
+## Usage
+
+TODO
+
+## Authors
+
+- **Jason Romano** - [Aracnid](https://github.com/aracnid)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

aracnid_core-0.1.3/aracnid_core/__init__.py

@@ -0,0 +1,3 @@
+from .base import BaseConnector
+
+__version__ = '0.1.3'

aracnid_core-0.1.3/aracnid_core/base.py

@@ -0,0 +1,38 @@
+from abc import ABC, abstractmethod
+from typing import Any, Dict, List, Optional
+
+
+class BaseConnector(ABC):
+    '''Abstract base class for CRUD operations across data sources.'''
+
+    @abstractmethod
+    def create(self, record: Dict) -> Dict:
+        pass
+
+    @abstractmethod
+    def read_one(self, record_id: str) -> Optional[Dict]:
+        pass
+
+    @abstractmethod
+    def read_many(self, filters: Optional[Dict] = None) -> List[Dict]:
+        pass
+
+    @abstractmethod
+    def update(self, record_id: str, changes: Dict) -> Dict:
+        pass
+
+    @abstractmethod
+    def replace(self, record_id: str, new_record: Dict) -> Dict:
+        pass
+
+    @abstractmethod
+    def delete_one(self, record_id: str, hard: bool = False) -> bool:
+        pass
+
+    @abstractmethod
+    def delete_many(self, filters: Optional[Dict] = None, hard: bool = False) -> int:
+        pass
+
+    @abstractmethod
+    def get_source_name(self) -> str:
+        pass

aracnid_core-0.1.3/pyproject.toml

@@ -0,0 +1,17 @@
+[tool.poetry]
+name = "aracnid-core"
+version = "0.1.3"
+description = "Base interfaces for Aracnid integration connectors"
+authors = ["Jason Romano <aracnid@gmail.com>"]
+license = "MIT"
+readme = "README.md"
+repository = "https://github.com/aracnid/aracnid-core"
+keywords = ["abstract", "connector"]
+packages = [{include = "aracnid_core"}]
+
+[tool.poetry.dependencies]
+python = "^3.10"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"