Additonal editing of README.md (#1289)

* Update README.md

* Cleanup .trivyignore

* Additional fix in README.md

* Remove unnecessary files

* Remove unnecessary files

* python:3.9.12 for Dockerfile

* long_description

* Fix steps names in master-ci.yml

.github/workflows/master-ci.yml

@@ -30,15 +30,15 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v1
 
-      - name: Login to auroraprodacr
+      - name: Login to production CR
         uses: docker/login-action@v1
         if: ${{ steps.prep.outputs.login_prod_cr  }}
         with:
           registry: ${{ env.DOCKER_PROD_REGISTRY }}
           username: ${{ secrets.DOCKER_PROD_USERNAME }}
           password: ${{ secrets.DOCKER_PROD_PASSWORD }}
 
-      - name: Login to auroradevacr
+      - name: Login to CR
         uses: docker/login-action@v1
         if: ${{ steps.prep.outputs.login_cr }}
         with:

.trivyignore

@@ -1,13 +0,0 @@
-# Remove after argo update
-CVE-2020-29652
-CVE-2020-14040
-CVE-2020-26160
-CVE-2021-3121
-# Remove after tensorflow update
-# Fixed in rsa >= 4.1
-CVE-2020-13757
-# Remove after mlflow update
-# Fixed in sqlparse >= 0.4.2
-CVE-2021-32839
-# Remove after tensorflow and update
-CVE-2018-20060

Dockerfile

@@ -1,5 +1,5 @@
 # Gordo base image
-FROM python:3.9.12-buster as builder
+FROM python:3.9.15-buster as builder
 
 # Copy source code
 COPY . /code
@@ -17,7 +17,7 @@ RUN cat /code/requirements/full_requirements.txt | grep tensorflow== > /code/pre
     && cat /code/requirements/full_requirements.txt | grep scipy== >> /code/prereq.txt \
     && cat /code/requirements/full_requirements.txt | grep catboost== >> /code/prereq.txt
 
-FROM python:3.9.12-slim-buster
+FROM python:3.9.15-slim-buster
 
 # Nonroot user for running CMD
 RUN groupadd -g 999 gordo && \

README.md

@@ -16,12 +16,6 @@
   <a href="https://github.com/equinor/gordo/actions?query=branch=master">
     <img src="https://github.com/equinor/gordo/workflows/CI/badge.svg?branch=master" alt="Build Status"/>
   </a>
-  <a href="https://codecov.io/gh/equinor/gordo">
-    <img src="https://codecov.io/gh/equinor/gordo/branch/master/graph/badge.svg" alt="Codecov"/>
-  </a>
-  <a href="https://gordo.readthedocs.io/en/latest/?badge=latest">
-    <img src="https://readthedocs.org/projects/gordo/badge/?version=latest" alt="Documentation"/>
-  </a> 
 </div>
 
 ---
@@ -57,6 +51,9 @@ See our [example](./examples) notebooks for how to develop with `gordo` locally.
 ## Install 
 `pip install --upgrade gordo`  
 
+With additional extras:
+`pip install gordo[postgres,mlflow]`  
+
 Bleeding edge:  
 `pip install git+https://github.com/equinor/gordo.git`
 
@@ -84,9 +81,9 @@ Note: you have to install `pip-tools` version higher then `6` for requirements t
 
 To update some package in `full_requirements.txt`:
 - Change its version in `requirements.in` file;
-- Compile requirements:
+- Compile and upgrade requirements:
 ```shell
-pip-compile --output-file=full_requirements.txt mlflow_requirements.in postgres_requirements.in requirements.in  
+pip-compile --upgrade --output-file=full_requirements.txt mlflow_requirements.in postgres_requirements.in requirements.in  
 ```
 
 ### How to run tests locally

setup.py

@@ -1,4 +1,6 @@
 import os
+
+from pathlib import Path
 from setuptools import setup, find_packages
 
 
@@ -31,18 +33,22 @@ def requirements(fp: str):
 if on_rtd:
     install_requires = [req for req in install_requires if "tensorflow" not in req]
 
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
+
 setup(
     author="Equinor ASA",
     author_email="[email protected]",
     classifiers=[
         "Intended Audience :: Developers",
         "License :: OSI Approved :: GNU Affero General Public License v3",
         "Natural Language :: English",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
     ],
     description="Train and build models for Argo / Kubernetes",
+    long_description=long_description,
+    long_description_content_type='text/markdown',
     entry_points={"console_scripts": ["gordo=gordo.cli:gordo"]},
     install_requires=install_requires,
     license="AGPLv3",