Metadata-Version: 2.1
Name: d2s
Version: 0.1.32
Summary: A Command Line Interface to orchestrate the integration of heterogenous data and the deployment of services consuming the integrated data. See https://d2s.semanticscience.org
Home-page: https://github.com/MaastrichtU-IDS/d2s-cli
Author: Vincent Emonet
Author-email: vincent.emonet@gmail.com
License: MIT License
Description: A Command Line Interface to orchestrate the integration of heterogenous data sources under a common [RDF Knowledge Graph](https://www.w3.org/RDF/) using [CWL workflows](https://www.commonwl.org/), and the deployment of user-facing services over the integrated data using [Docker](https://www.docker.com/) ([SPARQL](https://yasgui.triply.cc/), [GraphQL-LD](https://comunica.github.io/Article-ISWC2018-Demo-GraphQlLD/), [OpenAPI](https://www.openapis.org/), [Web UI](https://github.com/MaastrichtU-IDS/into-the-graph)).
        
        ## Installation 
        
        Complete documentation about the `d2s-cli` on the [d2s documentation website 📖](https://d2s.semanticscience.org/docs/d2s-installation)
        
        ### Install with pipx
        
        ```bash
        pipx install d2s cwlref-runner
        ```
        
        > Use [pip](https://pypi.org/project/pip/), pip3 or [pipx](https://pipxproject.github.io/pipx/) depending on your system preferences.
        
        Requirements:
        
        * [Python 3.6](https://d2s.semanticscience.org/docs/d2s-installation#install-pip)
        * [docker-compose](https://docs.docker.com/compose/install/)
        * git, time (bash)
        
        More detailed documentation to install pipx and `d2s` on various platforms available at [d2s.semanticscience.org](https://d2s.semanticscience.org/docs/d2s-installation#install-pipx)
        
        See [those instructions to install d2s on Windows](/docs/d2s-installation#install-pipx-on-windows) using the [Chocolatey package manager](https://chocolatey.org/) and [pipx](https://pipxproject.github.io/pipx/). 
        
        > Some features support are still a work in progress on Windows, such as CWL workflows (see the [official CWL Windows documentation](https://github.com/common-workflow-language/cwltool/blob/master/windowsdoc.md) to make it work)
        
        ### Enable autocompletion
        
        Enable commandline autocompletion in the terminal
        
        > Recommended, it makes `d2s` much more user-friendly 
        
        * **ZSH**: add the import autocomplete line to the `~/.zshrc` file.
        
        ```bash
        echo 'eval "$(_D2S_COMPLETE=source_zsh d2s)"' >> ~/.zshrc
        ```
        
        > Set your terminal to use [ZSH](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH) by default:
        >
        > ```shell
        > chsh -s /bin/zsh
        > ```
        
        > A [oh-my-zsh](https://ohmyz.sh/) theme can be easily chosen for a personalized experience. See [the zsh-theme-biradate](https://github.com/vemonet/zsh-theme-biradate) to easily install a simple theme and configure your terminal in a few minutes.
        
        * **Bash**: add the import autocomplete line to the `~/.bashrc` file.
        
        ```bash
        echo 'eval "$(_D2S_COMPLETE=source d2s)"' >> ~/.bashrc
        ```
        
        > **To be tested.**
        
        ### Try it
        
        Display the default help command
        
        ```bash
        d2s
        ```
        
        Create a d2s project in the given folder 
        
        ```bash
        d2s init project-folder-name
        ```
        
        All `d2s` commands are designed to be run from the project folder, move to it
        
        ```shell
        cd project-folder-name/
        ```
        
        > Project settings stored if `.d2sconfig` file.
        
        ### Upgrade d2s
        
        With `pipx`:
        
        ```bash
        pipx upgrade d2s
        ```
        
        With `pip`:
        
        ```bash
        pip install --upgrade d2s 
        ```
        
        ### Uninstall
        
        With `pipx`:
        
        ```bash
        pipx uninstall d2s cwlref-runner
        ```
        
        With `pip`:
        
        ```bash
        pip uninstall d2s cwlref-runner
        ```
        
        # Development setup
        
        Add new packages to use to [setup.py](https://github.com/MaastrichtU-IDS/d2s-cli/blob/master/setup.py#L16) (to be imported during the build). And install it locally for dev
        
        ```bash
        pip install package
        ```
        
        ### Install for dev
        
        Install `d2s` as executable in local for development. `d2s` will be updated directly on change in the code.
        
        ```bash
        pip install --editable .
        ```
        
        ## Build and publish
        
        To publish a new version on [pypi](https://pypi.org/project/d2s/), upgrade the version in [setup.py](https://github.com/MaastrichtU-IDS/d2s-cli/blob/master/setup.py#L6) and use the following script to build and publish automatically using [Docker](https://docs.docker.com/install/):
        
        ```bash
        ./publish_pip.sh
        ```
        
        ### Build locally
        
        This can be done locally:
        
        ```bash
        # Build packages in dist/ folder
        python3 setup.py sdist bdist_wheel
        # Publish packages previously built in the dist/ folder
        twine upload --repository-url https://upload.pypi.org/legacy/ dist/*
        ```
        
        Additional instructions to install twine locally (not needed)
        
        ```bash
        pipx install twine
        ```
        
        > If you experience issues with Bash or ZSH because `d2s` is not defined when installing for dev. Then add `pip install --editable develop/d2s-cli` to `.zshrc`
        
        You might need to install Python3.6 for dev (dev with python3.6 should work though)
        
        ```bash
        sudo apt-get install python3.6 python3.6-venv python3.6-dev
        # Set python3 to use 3.6
        sudo update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.6 1
        sudo update-alternatives --config python3
        ```
        
        > ```bash
        >vim /usr/bin/gnome-terminal
        > 
        > #!/usr/bin/python3.6
        > ```
        
        If you face issue uploading the package on pypi:
        
        ```bash
        twine check dist/d2s-*-py3-none-any.whl
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
