structifyai 0.0.2__tar.gz

structifyai-0.0.2/PKG-INFO

@@ -0,0 +1,17 @@
+Metadata-Version: 2.1
+Name: structifyai
+Version: 0.0.2
+Summary: Structify
+Home-page: 
+Author: Structify Team
+Author-email: team@structify.ai
+License: Discuss directly with founders for license.
+Keywords: OpenAPI,OpenAPI-Generator,Structify
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<2.1.0,>=1.25.3
+Requires-Dist: python-dateutil
+Requires-Dist: pydantic<2,>=1.10.5
+Requires-Dist: aenum
+
+    Unify all your unstructured knowledged into one structured source.
+    

structifyai-0.0.2/README.md

@@ -0,0 +1,107 @@
+# structifyai
+Unify all your unstructured knowledged into one structured source.
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 0.1.0
+- Package version: 0.0.2
+- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen
+
+## Requirements.
+
+Python 3.7+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+
+Then import the package:
+```python
+import structifyai
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import structifyai
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import time
+import structifyai
+from structifyai.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = structifyai.Configuration(
+    host = "http://localhost"
+)
+
+
+
+# Enter a context with an instance of the API client
+with structifyai.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = structifyai.DatasetApi(api_client)
+
+    try:
+        # Create a Dataset
+        api_instance.create()
+    except ApiException as e:
+        print("Exception when calling DatasetApi->create: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*DatasetApi* | [**create**](docs/DatasetApi.md#create) | **POST** /dataset/create | Create a Dataset
+*DatasetApi* | [**delete**](docs/DatasetApi.md#delete) | **POST** /dataset/delete | Remove a kg from the database
+*DatasetApi* | [**get**](docs/DatasetApi.md#get) | **POST** /dataset/get | Remove a kg from the database
+*DatasetApi* | [**list**](docs/DatasetApi.md#list) | **POST** /dataset/list | List knowledge graph
+*DatasetApi* | [**query**](docs/DatasetApi.md#query) | **GET** /dataset/query | Remove a kg from the database
+*ServerApi* | [**version**](docs/ServerApi.md#version) | **GET** /server/version | Version
+
+
+## Documentation For Models
+
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+Endpoints do not require authorization.
+
+
+## Author
+
+team@structify.ai
+
+

structifyai-0.0.2/examples/human.py

@@ -0,0 +1,14 @@
+from pydantic import Field
+from structify.orm.schema import SchemaInstance
+from structify.orm.value_types import UniqueText
+
+
+class Human(SchemaInstance):
+    """
+    Description: A Human
+    Version: 1
+    """
+
+    name: UniqueText = Field(description="The name of the person")
+    employer: UniqueText = Field(description="The last known employer of this person")
+    last_known_job_title: UniqueText = Field(description="The last known job title of the person")

structifyai-0.0.2/examples/manual_add_example.py

@@ -0,0 +1,35 @@
+"""
+This is an example of updating all your contacts from a CSV with
+publically available information.
+"""
+import os
+import pandas as pd
+from human import Human
+from structify import Client
+from structify.orm.value_types import UniqueText
+
+
+def main():
+    client = Client(auth=os.environ["STRUCTIFY_TOKEN"])
+
+    client.kg.create(name="acme", description="Test use case")
+
+    df = pd.read_csv("acme.csv")
+    for i, (name, title, company) in df.iterrows():
+        if i >= 2:
+            break
+        print(f"Adding {name} to the KG with values {title} and {company}")
+        if pd.isna(company):
+            continue
+        client.entities.add(
+            entity=Human(
+                name=UniqueText(value=name),
+                last_known_job_title=UniqueText(value=title),
+                last_known_job=UniqueText(value=company),
+            ),
+            name="acme",
+        )
+
+
+if __name__ == "__main__":
+    main()

structifyai-0.0.2/examples/schema_example.py

@@ -0,0 +1,18 @@
+import os
+from human import Human
+from structify import Client
+from structify.orm import Schema
+
+
+def main():
+    client = Client(auth=os.environ["STRUCTIFY_TOKEN"])
+    try:
+        client.schemas.get(name="Human")
+        client.schemas.delete(name="Human")
+    except Exception as e:
+        print(f"Schema didn't already exist: {e}")
+    client.schemas.add(Schema.from_pydantic(Human))
+
+
+if __name__ == "__main__":
+    main()

structifyai-0.0.2/examples/scrape_example.py

@@ -0,0 +1,17 @@
+import os
+from human import Human
+from structify import Client
+from structify.orm import Schema
+
+
+def main():
+    client = Client(auth=os.environ["STRUCTIFY_TOKEN"])
+    entity = client.researcher.on_demand_scrape(
+        query="Output the person who runs remote first capital.",
+        schema_name="Human",
+    )
+    print(entity)
+
+
+if __name__ == "__main__":
+    main()

structifyai-0.0.2/examples/test.py

@@ -0,0 +1,55 @@
+from pydantic import Field
+import os
+import pandas as pd
+from tqdm import tqdm
+
+from structify.orm.schema import Schema, SchemaInstance
+from structify.orm.value_types import UniqueText
+from structify import Client
+
+
+class AcmeHuman(SchemaInstance):
+    """
+    Description: AcmeHuman
+    Version: 0
+    """
+
+    name: UniqueText = Field(description="The name of the person")
+    employer: UniqueText = Field(description="The last known employer of this person")
+    last_known_job_title: UniqueText = Field(
+        description="The last known job title of the person"
+    )
+    link: UniqueText = Field(description="The link to the source of the information")
+
+
+def main():
+    client = Client(auth=os.environ["STRUCTIFY_TOKEN"])
+    # client.schemas.add(Schema.from_pydantic(AcmeHuman))
+    df = pd.read_csv("acme.csv")
+    new_df = []
+
+    results = []
+    for _, name, job, org in tqdm(df.itertuples()):
+        try:
+            entity = client.researcher.on_demand_scrape(
+                query=f"I know that {name} used to have the title of {job} at {org}. Where do they work now? Try to confirm we're talking about the same person.",
+                schema_name="AcmeHuman",
+            )
+            results.append(entity)
+            new_df.append(
+                {
+                    "name": entity[0].name,
+                    "job": entity[0].last_known_job_title,
+                    "org": entity[0].employer,
+                    "link": entity[0].link,
+                }
+            )
+        except Exception as e:
+            print(e)
+
+    new_df = pd.DataFrame(new_df)
+    new_df.to_csv("acme_results.csv")
+
+
+if __name__ == "__main__":
+    main()

structifyai-0.0.2/pyproject.toml

@@ -0,0 +1,30 @@
+[tool.poetry]
+name = "structifyai"
+version = "0.0.2"
+description = "Structify"
+authors = ["Structify Team <team@structify.ai>"]
+license = "Discuss directly with founders for license."
+readme = "README.md"
+repository = "https://github.com/GIT_USER_ID/GIT_REPO_ID"
+keywords = ["OpenAPI", "OpenAPI-Generator", "Structify"]
+include = ["structifyai/py.typed"]
+
+[tool.poetry.dependencies]
+python = "^3.7"
+
+urllib3 = ">= 1.25.3"
+python-dateutil = ">=2.8.2"
+pydantic = "^1.10.5, <2"
+aenum = ">=3.1.11"
+
+[tool.poetry.dev-dependencies]
+pytest = ">=7.2.1"
+tox = ">=3.9.0"
+flake8 = ">=4.0.0"
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.pylint.'MESSAGES CONTROL']
+extension-pkg-whitelist = "pydantic"

structifyai-0.0.2/setup.cfg

@@ -0,0 +1,7 @@
+[flake8]
+max-line-length = 99
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

structifyai-0.0.2/setup.py

@@ -0,0 +1,49 @@
+# coding: utf-8
+
+"""
+    Structify
+
+    Unify all your unstructured knowledged into one structured source.
+
+    Version: 0.1.0
+
+    Contact: team@structify.ai
+"""
+
+
+from setuptools import setup, find_packages  # noqa: H301
+
+# To install the library, run the following
+#
+# python setup.py install
+#
+# prerequisite: setuptools
+# http://pypi.python.org/pypi/setuptools
+NAME = "structifyai"
+VERSION = "0.0.2"
+PYTHON_REQUIRES = ">=3.7"
+REQUIRES = [
+    "urllib3 >= 1.25.3, < 2.1.0",
+    "python-dateutil",
+    "pydantic >= 1.10.5, < 2",
+    "aenum"
+]
+
+setup(
+    name=NAME,
+    version=VERSION,
+    description="Structify",
+    author="Structify Team",
+    author_email="team@structify.ai",
+    url="",
+    keywords=["OpenAPI", "OpenAPI-Generator", "Structify"],
+    install_requires=REQUIRES,
+    packages=find_packages(exclude=["test", "tests"]),
+    include_package_data=True,
+    license="Discuss directly with founders for license.",
+    long_description_content_type='text/markdown',
+    long_description="""\
+    Unify all your unstructured knowledged into one structured source.
+    """,  # noqa: E501
+    package_data={"structifyai": ["py.typed"]},
+)

structifyai-0.0.2/structifyai/__init__.py

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Structify
+
+    Unify all your unstructured knowledged into one structured source.
+
+    Version: 0.1.0
+
+    Contact: team@structify.ai
+"""
+
+
+__version__ = "0.0.2"
+
+# Import our wrapper object
+from structifyai.api_client import Client
+
+# import apis into sdk package
+from structifyai.api.dataset_api import DatasetApi
+from structifyai.api.server_api import ServerApi
+
+# import ApiClient
+from structifyai.api_response import ApiResponse
+from structifyai.api_client import ApiClient
+from structifyai.configuration import Configuration
+from structifyai.exceptions import OpenApiException
+from structifyai.exceptions import ApiTypeError
+from structifyai.exceptions import ApiValueError
+from structifyai.exceptions import ApiKeyError
+from structifyai.exceptions import ApiAttributeError
+from structifyai.exceptions import ApiException
+
+# import models into sdk package

structifyai-0.0.2/structifyai/api/__init__.py

@@ -0,0 +1,6 @@
+# flake8: noqa
+
+# import apis into api package
+from structifyai.api.dataset_api import DatasetApi
+from structifyai.api.server_api import ServerApi
+