Metadata-Version: 2.1
Name: aiojenkins
Version: 0.6.3
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: Async Python client for `Jenkins <https://jenkins.io>`_
        =======================================================
        
        Asynchronous python library of Jenkins API endpoints based on aiohttp.
        Initial version of aiojenkins. Public API is still unstable.
        
        Status
        ------
        
        |Build status|
        |Coverage status|
        |Version status|
        |Downloads status|
        
        .. |Build Status|
           image:: https://github.com/pbelskiy/aiojenkins/workflows/Tests/badge.svg
        .. |Coverage status|
           image:: https://img.shields.io/coveralls/github/pbelskiy/aiojenkins?label=Coverage
        .. |Version status|
           image:: https://img.shields.io/pypi/pyversions/aiojenkins?label=Python
        .. |Downloads status|
           image:: https://img.shields.io/pypi/dm/aiojenkins?color=1&label=Downloads
        
        Installation
        ------------
        
        ::
        
            pip install aiojenkins
        
        
        Documentation
        -------------
        
        `Read the Docs <https://aiojenkins.readthedocs.io/en/latest/>`_
        
        Usage
        -----
        
        Start new build:
        
        .. code:: python
        
            import asyncio
            import aiojenkins
        
            jenkins = aiojenkins.Jenkins('http://your_server/jenkins', 'login', 'password')
        
            async def example():
                await jenkins.builds.start('job_name', dict(parameter='test'))
        
            loop = asyncio.get_event_loop()
            try:
                loop.run_until_complete(example())
            finally:
                loop.run_until_complete(jenkins.close())
                loop.close()
        
        `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`
        
        ::
        
            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
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.5
Description-Content-Type: text/x-rst
