Metadata-Version: 1.2
Name: pybel-git
Version: 0.0.1
Summary: PyBEL Git utilities
Home-page: https://github.com/cthoyt/pybel-git
Author: Charles Tapley Hoyt
Author-email: charles.hoyt@scai.fraunhofer.de
Maintainer: Charles Tapley Hoyt
Maintainer-email: charles.hoyt@scai.fraunhofer.de
License: MIT
Download-URL: https://github.com/cthoyt/pybel-git/releases
Project-URL: Bug Tracker, https://github.com/cthoyt/pybel-git/issues
Project-URL: Source Code, https://github.com/cthoyt/pybel-git
Description: pybel-git
        =========
        Git and continuous integration tools for PyBEL to assist in curating BEL.
        
        Using GitHub and Travis-CI
        --------------------------
        To configure `Travis-CI <https://travis-ci.com>`_ to evaluate the 
        BEL files that have changed in the latest commit to a in a GitHub 
        repository on each commit, the following ``travis.yml`` file can 
        be used:
        
        .. code-block:: yaml
        
        	sudo: false
        	cache: pip
        	language: python
        	python:
        	- 3.6
        	install:
        	- pip install git+https://github.com/cthoyt/pybel-git
        	script:
        	- pybel-git ci
        
        Currently, the build doesn't use a cached resource file, so this job
        might take a long time. The `travis_wait <https://docs.travis-ci.
        com/user/common-build-problems/#build-times-out-because-no-output-
        was-received>`_ command can be used so the script reads
        ``travis_wait 30 pybel-git ci`` and the job will be allowed to run for
        thirty (30) minutes.
        
        An example can be found at https://github.com/cthoyt/pybel-git-test.
        
        Using GitLab with GitLab CI/CD
        ------------------------------
        To configure `GitLab CI/CD <https://docs.gitlab.com/ee/ci>`_ to 
        evaluate the BEL files that have changed in the latest commit to
        a GitLab repository, the following ``.gitlab-ci.yml`` can be used:
        
        .. code-block:: yaml
        
           test:
             image: python:3.6
             script:
             - pip install git+https://github.com/cthoyt/pybel-git
             - pybel-git ci
        
        As with GitHub/Travis-CI, this configuration does not use a cached
        resource file. GitLab CI/CD doesn't seem to offer a wait time, but
        it might also not have an issue with timing out, either.
        
        An example can be found at https://gitlab.com/cthoyt/pybel-gitlab-example
        
        
        Deeper Integration with GitLab
        ------------------------------
        PyBEL-Git contains extra scripts to assist in automatic checking and feedback
        for projects residing in GitLab that are using the Git Flow workflow of branching
        and making merge requests.
        
        This script checks each branch, compiles the BEL documents that have changed
        compared to master, and puts comments on the merge request with the warnings
        and feedback on the syntactic and semantic correctness of the BEL files.
        
        It can be run with:
        
        .. code-block:: bash
        
        	pybel-git ci_gitlab \
        	    --url "https://gitlab.scai.fraunhofer.de"  # the url of the desired gitlab instance \
        	    --project-id 449  # the gitlab project id, shown at the top of the page for the repository \
        
        This script uses `EasyConfig <https://github.com/scolby33/easy_config>`_ and can also be configured
        via the environment variables ``GITLAB_URL``, ``GITLAB_PROJECT_ID``, and ``GITLAB_TOKEN``.
        
Keywords: Biological Expression Language,Protein Protein Interaction Networks
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6
