semvec/pypi-packages huggingface dataset:
cf-predict 0.1.2
Cloud Foundry Python Predictive API Boilerplate
License: MIT

cf-predict
==========

Cloud Foundry Python Predictive API Boilerplate

| |Build Status|
| |Coverage Status|
| |Scrutinizer Code Quality|
| |PyPI Version|
| |PyPI Downloads|

About
-----

The cf-predict microservice is part of a pluggable ecosystem of cloud
native data science microservices for Cloud Foundry.

|Data Science Microservices|

Getting Started
---------------

Requirements
~~~~~~~~~~~~

-  Python 3.4+

Installation
~~~~~~~~~~~~

cf-predict can be installed with pip:

::

    $ pip install cf-predict

or directly from the source code:

::

    $ git clone https://github.com/ronert/cf-predict.git
    $ cd cf-predict
    $ python setup.py install

File Structure
~~~~~~~~~~~~~~

Basic Usage
-----------

After installation, the package can imported:

::

    $ python
    >>> import cf_predict
    >>> cf_predict.__version__

Development
-----------

Make environment
~~~~~~~~~~~~~~~~

``make env``

Development Installation
~~~~~~~~~~~~~~~~~~~~~~~~

``make develop``

System Installation
~~~~~~~~~~~~~~~~~~~

``make install``

Run All Tests
~~~~~~~~~~~~~

``make tests``

Unit Tests
^^^^^^^^^^

``make test-unit``

Integration Tests
^^^^^^^^^^^^^^^^^

``make test-int``

Read Coverage
^^^^^^^^^^^^^

``make read-coverage``

Run CI
~~~~~~

``make ci``

Static Analaysis
~~~~~~~~~~~~~~~~

``make check``

Watch
~~~~~

``make watch``

Release
~~~~~~~

``make upload``

Documentation
-------------

Read the full documentation
`here <http://ronert.github.io/cf-predict>`__.

.. |Build Status| image:: http://img.shields.io/travis/ronert/cf-predict/master.svg
   :target: https://travis-ci.org/ronert/cf-predict
.. |Coverage Status| image:: http://img.shields.io/coveralls/ronert/cf-predict/master.svg
   :target: https://coveralls.io/r/ronert/cf-predict
.. |Scrutinizer Code Quality| image:: http://img.shields.io/scrutinizer/g/ronert/cf-predict.svg
   :target: https://scrutinizer-ci.com/g/ronert/cf-predict/?branch=master
.. |PyPI Version| image:: http://img.shields.io/pypi/v/cf-predict.svg
   :target: https://pypi.python.org/pypi/cf-predict
.. |PyPI Downloads| image:: http://img.shields.io/pypi/dm/cf-predict.svg
   :target: https://pypi.python.org/pypi/cf-predict
.. |Data Science Microservices| image:: https://dropshare-ro.s3-eu-central-1.amazonaws.com/Microservices.jpg

Revision History
================

0.0.0 (YYYY/MM/DD)
------------------

-  TBD