Metadata-Version: 2.1
Name: aiojenkins
Version: 0.5.0
Summary: Asynchronous library of Jenkins API based on aiohttp
Home-page: https://github.com/pbelskiy/aiojenkins
Author: Petr Belskiy
Author-email: petr.belskiy@gmail.com
License: MIT
Download-URL: https://pypi.org/project/aiojenkins
Description: # aiojenkins
        
        ![Tests](https://github.com/pbelskiy/aiojenkins/workflows/Tests/badge.svg)
        ![Coveralls github](https://img.shields.io/coveralls/github/pbelskiy/aiojenkins?label=Coverage)
        ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aiojenkins?label=Python)
        ![PyPI - Downloads](https://img.shields.io/pypi/dm/aiojenkins?color=1&label=Downloads)
        
        Asynchronous python library of Jenkins API endpoints based on aiohttp 🥳
        
        Initial version of aiojenkins. Public API is still unstable (work is in progress)
        
        ## Installation
        
        ```sh
        pip install aiojenkins
        ```
        
        ## Usage
        
        Start new build:
        ```python
        import asyncio
        import aiojenkins
        
        async def example():
            jenkins = aiojenkins.Jenkins('http://your_server/jenkins', 'login', 'password')
            await jenkins.builds.start('job_name', dict(parameter='test'))
        
        asyncio.run(example())
        ```
        [__Please look at tests directory for more examples.__](https://github.com/pbelskiy/aiojenkins/tree/master/tests)
        
        ## Testing
        
        Currently tests aren't using any mocking.
        I am testing locally with dockerized LTS Jenkins ver. 2.222.3
        
        Prerequisites: `docker, pytest pytest-cov pytest-asyncio`
        
        ```sh
        docker run -d --name jenkins --restart always -p 8080:8080 jenkins/jenkins:lts
        docker exec jenkins cat /var/jenkins_home/secrets/initialAdminPassword
        python3 -m pytest -v --cov=aiojenkins --cov-report=term --cov-report=html
        ```
        
        ## Contributing
        
        Feel free to PR :)
        
Keywords: aiojenkins,async jenkins api
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
Description-Content-Type: text/markdown
