https://github.com/lapets/canary-test

CI/CD test.
https://github.com/lapets/canary-test

Last synced: 3 months ago
JSON representation

CI/CD test.

• Host: GitHub
• URL: https://github.com/lapets/canary-test
• Owner: lapets
• Created: 2020-07-17T20:47:55.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-07-18T06:04:25.000Z (over 5 years ago)
• Last Synced: 2025-03-17T03:13:11.196Z (10 months ago)
• Language: Python
• Size: 30.3 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

          
========

canaries

========

Python library for choosing and loading dynamic library files compatible with the operating environment.

|pypi| |travis| |coveralls|

.. |pypi| image:: https://badge.fury.io/py/canaries.svg

   :target: https://badge.fury.io/py/canaries

   :alt: PyPI version and link.

.. |travis| image:: https://travis-ci.com/reity/canaries.svg?branch=master

    :target: https://travis-ci.com/reity/canaries

.. |coveralls| image:: https://coveralls.io/repos/github/reity/canaries/badge.svg?branch=master

   :target: https://coveralls.io/github/reity/canaries?branch=master

Purpose

-------

This tool can be used to automatically choose and load a dynamic library file that is compatible with the current operating environment.

Package Installation and Usage

------------------------------

The package is available on PyPI::

    python -m pip install canaries

The library can be imported in the usual way::

    import canaries

    from canaries import canaries

Testing and Conventions

-----------------------

All unit tests are executed and their coverage is measured when using `nose `_ (see ``setup.cfg`` for configution details)::

    nosetests

Style conventions are enforced using `Pylint `_::

    pylint canaries

Contributions

-------------

In order to contribute to the source code, open an issue or submit a pull request on the GitHub page for this library.

Versioning

----------

The version number format for this library and the changes to the library associated with version number increments conform with `Semantic Versioning 2.0.0 `_.