Metadata-Version: 2.1
Name: t3-core
Version: 0.3.2
Summary: Boilerplate to quickly setup a Django Rest Framework Microservice for T3
Home-page: https://github.com/nwcell/t3_django_microservice
Author: Travis Krause
Author-email: travis.krause@t-3.com
License: UNKNOWN
Keywords: t3 t3-python-core
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: pip (>=10.0)
Requires-Dist: Django (>=2.0)
Requires-Dist: gunicorn (==19.8.1)
Requires-Dist: psycopg2-binary (==2.7.4)
Requires-Dist: djangorestframework (>=3.8)
Requires-Dist: django-filter (>=1.1)
Requires-Dist: markdown (>=2.6)
Requires-Dist: coreapi (>=2.3)
Requires-Dist: django-crispy-forms (==1.7.2)
Requires-Dist: drf-yasg[validation] (==1.7.4)
Requires-Dist: boto3 (==1.7.6)
Requires-Dist: django-storages (==1.6.6)
Requires-Dist: watchtower (==0.5.3)
Requires-Dist: django-prometheus (==1.0.13)
Requires-Dist: requests (==2.18.4)
Requires-Dist: python-dotenv[cli] (==0.8.2)
Requires-Dist: pygments (==2.2.0)
Requires-Dist: coverage (==4.5.1)
Requires-Dist: pytest (==3.5.1)
Requires-Dist: pytest-cov (==2.5.1)
Requires-Dist: pytest-django (==3.2.1)
Requires-Dist: pytest-dotenv (==0.1.1)
Requires-Dist: pylint (==1.8.4)
Requires-Dist: pylint-django (==0.11)
Requires-Dist: pep8 (==1.7.1)
Requires-Dist: autopep8 (==1.3.5)
Requires-Dist: pylama (==7.4.3)
Requires-Dist: pylama-pylint (==3.0.1)
Requires-Dist: m2r (==0.1.14)


T3 Python Core Library
======================


.. image:: https://gitlab.t-3.com/sunoco/t3-python-core/badges/master/pipeline.svg
   :target: https://gitlab.t-3.com/sunoco/t3-python-core/commits/master
   :alt: pipeline status


.. image:: https://gitlab.t-3.com/sunoco/t3-python-core/badges/master/coverage.svg
   :target: https://gitlab.t-3.com/sunoco/t3-python-core/commits/master
   :alt: coverage report


.. image:: https://badge.fury.io/py/t3-core.svg
   :target: https://badge.fury.io/py/t3-core
   :alt: PyPI version


Install
-------

Setup Virtualenv (optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: sh

   python -m venv .venv
   source .venv/bin/activate

   # There is a bug in pip 9.x  go ahead and upgrade to make sure that you're pip 10.x
   pip install --upgrade pip

Install
^^^^^^^

.. code-block:: sh

   # Install from pypi
   pip install t3-core

   # Install in the `src` dir of your python environment
   pip install -e git+ssh://git@gitlab.t-3.com/sunoco/t3-python-core.git

   # Choose where the clone lives
   git clone ssh://git@gitlab.t-3.com/sunoco/t3-python-core.git
   pip install -e ./t3-python-core

Testing & Linting
-----------------

Test & Coverage Report
^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: sh

   pytest

Lint
^^^^

.. code-block:: sh

   pylama


