Metadata-Version: 2.1
Name: graphio
Version: 0.0.16
Summary: Library to load data sets to Neo4j.
Home-page: https://github.com/kaiserpreusse/graphio
Author: Martin Preusse
Author-email: martin.preusse@gmail.com
License: Apache License 2.0
Description: # GraphIO
        
        [![Build Status](https://travis-ci.com/kaiserpreusse/graphio.svg?branch=master)](https://travis-ci.com/kaiserpreusse/graphio)
        [![PyPI](https://img.shields.io/pypi/v/graphio)](https://pypi.org/project/graphio)
        [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
        [![Neo4j](https://img.shields.io/badge/Neo4j-3.4%20%7C%203.5%20%7C%204.0-blue)](https://neo4j.com)
        
        A Python library to quickly build data sets and load them to Neo4j. Built by [Kaiser & Preusse](https://kaiser-preusse.com).
        
        ## Documentation
        [![Documentation Status](https://readthedocs.org/projects/graphio/badge/?version=latest)](https://graphio.readthedocs.io/en/latest/?badge=latest)
        
        Docs available at: https://graphio.readthedocs.io/
        
        Tutorial with real data: https://graphdb-bio.com/graphio-tutorial-idmapping
        
        ## Install
        Install graphio from PyPI:
        
        ```shell script
        pip install graphio
        ```
        
        Install the latest build version from github:
        
        ```shell script
        pip install git+https://github.com/kaiserpreusse/graphio.git
        ```
        
        ## Status
        This is an early release with a focus on data loading.
        
        ## Development
        You need Docker to run the test suite. Two Neo4j Docker containers will be started before running the tests, one for version 3.5 and another for version 4.
        All tests that use the `graph` fixture found in `tests/conftest.py` will run against both databases.
        
        ### Run test suite with local environment
        - create a new Python environment
        - install package dependencies with `pip install -r requirements.txt`
        - install test dependencies with `pip install -r test_requirements.txt`
        - run the script `run_test_local_env.sh`, the script will start two Docker containers with Neo4j and run pytest against the source files
        
        
        ### Run test suite with tox
        [tox](https://tox.readthedocs.io/en/latest/) is a test automation tool that automatically creates new virtual environments, installs dependencies and runs the tests. 
        It can run the tests against multiple Python versions. You have to install all Python versions that are tested and they have to be discoverable
        by [tox](https://tox.readthedocs.io/en/latest/). The suggested way to install multiple Python versions is [pyenv](https://github.com/pyenv/pyenv).
        
        - install Python 3.5, 3.6, 3.7, 3.8 with [pyenv](https://github.com/pyenv/pyenv)
        - allow [tox](https://tox.readthedocs.io/en/latest/) to discover the Python executables by using [`pyenv local`](https://github.com/pyenv/pyenv/blob/master/COMMANDS.md#pyenv-local) in the graphio source directory
        - run the script `run_test_tox.sh`, the script will start two Docker containers with Neo4j and run `tox` with the `--recreate` flag.
        
        
        ## Feedback
        Please provide feedback, ideas and bug reports through github issues.
        
        
        
Keywords: NEO4J
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Description-Content-Type: text/markdown
