graflo 1.1.0__py3-none-any.whl

graflo-1.1.0.dist-info/METADATA

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: graflo
+Version: 1.1.0
+Summary: (!) Deprecated: this package has been renamed to GraFlo. A framework for transforming tabular (CSV, SQL) and hierarchical data (JSON, XML) into property graphs and ingesting them into graph databases (ArangoDB, Neo4j)
+Author-email: Alexander Belikov <alexander@growgraph.dev>
+License-File: LICENSE
+Requires-Python: ~=3.11.0
+Requires-Dist: click<9,>=8.2.0
+Requires-Dist: ijson<4,>=3.2.3
+Requires-Dist: neo4j<6,>=5.22.0
+Requires-Dist: networkx~=3.3
+Requires-Dist: pandas-stubs==2.3.0.250703
+Requires-Dist: pandas<3,>=2.0.3
+Requires-Dist: python-arango<9,>=8.1.2
+Requires-Dist: suthing<0.5,>=0.4.1
+Requires-Dist: xmltodict<0.15,>=0.14.2
+Description-Content-Type: text/markdown
+
+# GraFlo <img src="https://raw.githubusercontent.com/growgraph/graflo/main/docs/assets/favicon.ico" alt="graflo logo" style="height: 32px; width:32px;"/>
+
+A framework for transforming **tabular** (CSV, SQL) and **hierarchical** data (JSON, XML) into property graphs and ingesting them into graph databases (ArangoDB, Neo4j).
+
+> **⚠️ Package Renamed**: This package was formerly known as `graphcast`.
+
+[Rest of your existing README content...]
+
+![Python](https://img.shields.io/badge/python-3.11-blue.svg) 
+[![PyPI version](https://badge.fury.io/py/graflo.svg)](https://badge.fury.io/py/graflo)
+[![PyPI Downloads](https://static.pepy.tech/badge/graflo)](https://pepy.tech/projects/graflo)
+[![License: BSL](https://img.shields.io/badge/license-BSL--1.1-green)](https://github.com/growgraph/graflo/blob/main/LICENSE)
+[![pre-commit](https://github.com/growgraph/graflo/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/growgraph/graflo/actions/workflows/pre-commit.yml)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15446131.svg)]( https://doi.org/10.5281/zenodo.15446131)
+
+## Core Concepts
+
+### Property Graphs
+graflo works with property graphs, which consist of:
+
+- **Vertices**: Nodes with properties and optional unique identifiers
+- **Edges**: Relationships between vertices with their own properties
+- **Properties**: Both vertices and edges may have properties
+
+### Schema
+The Schema defines how your data should be transformed into a graph and contains:
+
+- **Vertex Definitions**: Specify vertex types, their properties, and unique identifiers
+- **Edge Definitions**: Define relationships between vertices and their properties
+- **Resource Mapping**: describe how data sources map to vertices and edges
+- **Transforms**: Modify data during the casting process
+
+### Resources
+Resources are your data sources that can be:
+
+- **Table-like**: CSV files, database tables
+- **JSON-like**: JSON files, nested data structures
+
+## Features
+
+- **Graph Transformation Meta-language**: A powerful declarative language to describe how your data becomes a property graph:
+    - Define vertex and edge structures
+    - Set compound indexes for vertices and edges
+    - Use blank vertices for complex relationships
+    - Specify edge constraints and properties
+    - Apply advanced filtering and transformations
+- **Parallel processing**: Use as many cores as you have
+- **Database support**: Ingest into ArangoDB and Neo4j using the same API (database agnostic)
+
+## Documentation
+Full documentation is available at: [growgraph.github.io/graflo](https://growgraph.github.io/graflo)
+
+## Installation
+
+```bash
+pip install graflo
+```
+
+## Usage Examples
+
+### Simple ingest
+
+```python
+from suthing import ConfigFactory, FileHandle
+
+from graflo import Schema, Caster, Patterns
+
+
+schema = Schema.from_dict(FileHandle.load("schema.yaml"))
+
+conn_conf = ConfigFactory.create_config({
+        "protocol": "http",
+        "hostname": "localhost",
+        "port": 8535,
+        "username": "root",
+        "password": "123",
+        "database": "_system",
+}
+)
+
+patterns = Patterns.from_dict(
+    {
+        "patterns": {
+            "work": {"regex": "\Sjson$"},
+        }
+    }
+)
+
+schema.fetch_resource()
+
+caster = Caster(
+    schema,
+)
+
+caster.ingest_files(
+    path="./data",
+    conn_conf=conn_conf,
+    patterns=patterns,
+)
+```
+
+## Development
+
+To install requirements
+
+```shell
+git clone git@github.com:growgraph/graflo.git && cd graflo
+uv sync --dev
+```
+
+### Tests
+
+#### Test databases
+Spin up Arango from [arango docker folder](./docker/arango) by
+
+```shell
+docker-compose --env-file .env up arango
+```
+
+and Neo4j from [neo4j docker folder](./docker/arango) by
+
+```shell
+docker-compose --env-file .env up neo4j
+```
+
+To run unit tests
+
+```shell
+pytest test
+```
+
+## Requirements
+
+- Python 3.11+
+- python-arango
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

graflo-1.1.0.dist-info/RECORD

@@ -0,0 +1,45 @@
+graflo/README.md,sha256=epqV1Cpmogy6RnTNeu-K0JhO_gVY82RzeLFN6kvG7Is,377
+graflo/__init__.py,sha256=f_g9EmicA3JZYUTRsmSpsNvtLafU4DsUPhBy0Rss-R8,1146
+graflo/caster.py,sha256=OyFYBtbHz8HsYlYHmRuZy1KH-Ia6DlHWV6KmreqOwzA,15519
+graflo/logging.conf,sha256=coIMi-VlXrBEfoczsY986ax20NZ2e11yi4hFWSwpwDM,372
+graflo/onto.py,sha256=znY0uMqtPcK0qCSNSsipFTmoq_-88o2lHpmOPRr7jZ4,5745
+graflo/architecture/__init__.py,sha256=aNEXtm5HKqpKSI0EQRbWY1PcttgnBlS3tUTxq_xT3fo,1065
+graflo/architecture/actor.py,sha256=w3ZpQUV5_bIEllQ3_myIt_E4urZFiKkC9RmoytCDu2c,30125
+graflo/architecture/actor_util.py,sha256=7bcQbUffQ-wu6OpWViTWNcC7m4h09_E2yz4UGEWwmRQ,16064
+graflo/architecture/edge.py,sha256=sPdF3yg-e-IyLJRhSu_lidJsVAdXtrj5ze1bjDYDAYM,9343
+graflo/architecture/onto.py,sha256=CRqiuyf7hmPxvNElOkfQZ7Mmr_SAecDG0FFfawgWA4s,11378
+graflo/architecture/resource.py,sha256=IqSoLlFfygWUf_1Z6Sh66CW6N8BRU49oJWJXtzcQ4a4,5048
+graflo/architecture/schema.py,sha256=2pi4RVCQ-jXADIVm8geMy1Yjkn1smRp-uTZdpjXMDM4,4506
+graflo/architecture/transform.py,sha256=xdtRbb7wJelK0bCSPQO1DAS6a84C2mYtweX308siA9A,9431
+graflo/architecture/util.py,sha256=UYu_WP5aKxL92rzBWHJHMQ0B-i3eFfdQqDKJZaAXaIc,2971
+graflo/architecture/vertex.py,sha256=haHs9RA9co9yCVzBdwh2pXcLX4S8RtKsgB_nyCVPoQ0,8254
+graflo/cli/__init__.py,sha256=u5YFigokhv46foL9P5YQDOIICQ2v6CMErlByucaarSs,449
+graflo/cli/ingest.py,sha256=z7wUgTAxKny5buyQuh1R05zt8SrQfC3Mn_cnzeNZJZQ,4175
+graflo/cli/manage_dbs.py,sha256=bHm3A-beVSzeddISXcX1GOwbSiq_ALss6l_RYIyVniw,6146
+graflo/cli/plot_schema.py,sha256=rRmg8VfOl23fhebD2NahembfiWywvBU_4yXU_VVkCYQ,4300
+graflo/cli/xml2json.py,sha256=pi4KDtOsVVVuxmu0DtZUOJCP3VXjDGOfHQOR6HaVQk4,2668
+graflo/db/__init__.py,sha256=smVgLwrIUH6eD1EmMbITKZOnEMkRjeqdibExaVyYXr0,1037
+graflo/db/connection.py,sha256=VqFXfuN-HMTEsBuvlHm5imMf_GkWuh4HHgw--PYss3s,8701
+graflo/db/manager.py,sha256=40hVWjOsGi2N2jJx5ET8Yy4gVaEz41ConeukixvTK5o,3322
+graflo/db/util.py,sha256=IgS32BaWKoSpsq1yqIfq9iVmXkJJFdRBDX4NOi66dgA,1461
+graflo/db/arango/__init__.py,sha256=P3ASimdlyX-8FuSH0kBsNdGI9AIomCuYI8izs6tP__A,567
+graflo/db/arango/conn.py,sha256=UzyiTtcPTe4L1NIvjAOTWYNU0OMhh5ht0YMis_uFP4w,25584
+graflo/db/arango/query.py,sha256=t_RKltpWh0L3V0FJst38vMf7QsmjzTndgBR3ooAahmM,5655
+graflo/db/arango/util.py,sha256=uSjWSb1QobzymZUZxOqneSbsHkj8DqIa9ejQts3P4XA,2955
+graflo/db/neo4j/__init__.py,sha256=KB4zd06CNCmTs5KotfQ_4petaCLOJnUZ1oD4CaRJTnQ,547
+graflo/db/neo4j/conn.py,sha256=7kLUdORqErxXL7oCfAfOKnbcGyw_7w99gz8TMGMt6R8,13681
+graflo/filter/__init__.py,sha256=OyV5pavlOrWQeS4fwHA-tcKcNccXxGr2d--TKPYlXyE,814
+graflo/filter/onto.py,sha256=Kf-I5KBVxorEpUV_rviG0XS6uwqTF9Xd7DkPGPZAPgw,11657
+graflo/plot/__init__.py,sha256=ITlvw8_FRNXPqtjiou946Hv923iixGvR6c4Uqrg-L2o,485
+graflo/plot/plotter.py,sha256=yv-tyKJViLU3CKg8lfBWJ8_WCxdcnGgY1G_VzhHq0lE,17710
+graflo/util/__init__.py,sha256=aZsSxHD1vzADUvzHVuYrx2TL-EUye7tcw2IeX81EB38,706
+graflo/util/chunker.py,sha256=U27d9_baVTtDaAJX0GxhfoN7SN6VPNbx7ArwkSMaIgI,21382
+graflo/util/merge.py,sha256=jKs7o7xPkXJIy52Uaz0rtHyhXoIJAZUmiD0N4ObT8PE,5397
+graflo/util/misc.py,sha256=Fwl8HhbBm-ZXbqDotnZ39gDPoTfUKeonZAi4pPWY99M,1171
+graflo/util/onto.py,sha256=W1i00XP-qsQpTlGqCiR1J_EawcsKNLr4Qfts0uGbKiM,1911
+graflo/util/transform.py,sha256=tnZbNLw4ArdpR62bXUPhDvQ547OZGLGUBkJHTn7O0zo,10984
+graflo-1.1.0.dist-info/METADATA,sha256=c6aTKMKuc8-nN2LQcPEs3lyGry8oglqF61efko3isbg,4636
+graflo-1.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+graflo-1.1.0.dist-info/entry_points.txt,sha256=kjDXqHgIrppqxQe6RO6XjLrq7VL50AaVHhLg7c95Oxc,190
+graflo-1.1.0.dist-info/licenses/LICENSE,sha256=ILn9MXR5AfuRRtOF8abQWhm0wO8kckf4IBdc6mKaRG8,5593
+graflo-1.1.0.dist-info/RECORD,,

graflo-1.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

graflo-1.1.0.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+ingest = graflo.cli.ingest:ingest
+manage_dbs = graflo.cli.manage_dbs:manage_dbs
+plot_schema = graflo.cli.plot_schema:plot_schema
+xml2json = graflo.cli.plot_schema:xml2json

graflo-1.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,126 @@
+Business Source License 1.1
+
+Parameters
+
+Licensor:             Growgraph SAS
+Licensed Work:        GraFlo
+                      The Licensed Work is (c) 2025 GraFlo
+                      Formerly GraphCast
+
+Additional Use Grant:
+    The Licensor hereby grants you the right to make production use of the Licensed Work
+    if any of the following conditions are met:
+
+    - Your organization's annual revenue does not exceed USD 100,000
+    - You are not offering a commercially available product or service that
+        competes with the Licensor's products or services
+
+Definitions:
+    "Production Use" means any use of the Licensed Work in a production environment,
+        including but not limited to:
+
+    - Deploying the Licensed Work to serve production traffic
+    - Using the Licensed Work to process real customer data
+    - Incorporating the Licensed Work into a commercial product or service
+    - Using the Licensed Work to generate revenue directly or indirectly
+
+"Competing Product or Service" means any product or service that:
+
+    - Provides substantially similar functionality to the Licensed Work
+    - Offers the Licensed Work as a hosted or managed service
+    - Incorporates the Licensed Work into a broader product or service that competes
+        with the Licensor's current or reasonably anticipated products or services
+
+"Non-Production Use" means:
+
+    - Development and testing in isolated environments
+    - Academic research and educational purposes
+    - Evaluation of the Licensed Work for potential purchase of a commercial license
+    - Personal, non-commercial projects where the Licensed Work is not used to generate revenue
+
+Change Date:          2029-05-01
+
+Change License:       Apache License, Version 2.0
+
+For information about alternative licensing arrangements for the Software,
+please contact: <team@growgraph.dev>
+
+Notice
+
+The Business Source License (this document, or the “License”) is not an Open
+Source license. However, the Licensed Work will eventually be made available
+under an Open Source License, as stated in this License.
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+“Business Source License” is a trademark of MariaDB Corporation Ab.
+
+-----------------------------------------------------------------------------
+
+Business Source License 1.1
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License’s text to license
+your works, and to refer to it using the trademark “Business Source License”,
+as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+
+In consideration of the right to use this License’s text and the “Business
+Source License” name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where “compatible” means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text “None”.
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.