Merge pull request #15 from DevoInc/BREAKING-CHANGE/Update_API

First deployment

Author: pabloroldan98

.github/workflows/documentation.yml

@@ -36,7 +36,9 @@ jobs:
           echo "RELEASE_VERSION=${POETRY_VERSION}" >> $GITHUB_ENV
       - name: Install dependencies
         run: |
-          pip install sphinx sphinx_rtd_dark_mode
+          pip install sphinx
+          pip install sphinx-autodoc-typehints
+          pip install furo
       - name: Sphinx build
         run: |
           sphinx-build docs/source _build

.github/workflows/publish-test.yml

@@ -11,7 +11,7 @@ name: Publish Python Package to TestPypi
 # After bumping version (when closed Pull Requests to main) and tests are passed
 on:
   workflow_run:
-    workflows: ["Bump version", "Test with tox"]
+    workflows: ["Bump version"]
     types:
       - completed
 

CHANGELOG.md

@@ -1,2 +1,9 @@
-#### 0.0.1
-- Remake of Makeijan Python Client > ML Model Manager
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2022-10-25
+#### Added
+ * First release.

CONTRIBUTING.md

@@ -1,6 +1,87 @@
-# Contributing
+# Contributing to Devo
+
+There are many ways to contribute to Devo. Here are some of them:
+
+
+1. [Report bugs](#reporting-bugs) or request features in the [issue tracker](https://github.com/DevoInc/python-mlmodelmanager-client/issues).
+2. [Submit patches](#submit-patch) for bug fixes and/or new features.
+
+## Reporting bugs
+
+Well-written bug reports are very helpful, keep in mind this guideline when 
+reporting a new bug.
+
+* Check the open issues to see if it has already been reported.
+* Write complete, reproducible, specific bug reports: the smaller the test case,
+ better. 
+* Includes the output of the library with all the error information
+
+
+## Submit patch
+To be able to make a fork and the corresponding MR you have to accept Devo's CLA
+The process to modify one package or script is the next:
+
+1. Create your fork from main
+2. Create a branch that determines the change. The branch name determines the versioning, if it starts with:
+    - BREAK or MAJOR ⟶ MAJOR (1.2.3 ⟶ 2.0.0)
+    - FEAT or MINOR ⟶ MINOR (1.2.3 ⟶ 1.3.0)
+    - Anything else ⟶ PATCH (1.2.3 ⟶ 1.2.4)
+3. Add to the `CHANGELOG.md`, in 
+[`Unreleased`](#How_can_I_minimize_the_effort_required?) the tasks 
+that you are going to take or are carrying out to be able to review at a quick 
+glance the objective of the branch.
+4. Make your awesome code
+5. Never forget to **change the changelog**.  
+4.1 [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+6. Create a Pull Request to master with correct version and tests passed.
+
+
+## Keep a CHANGELOG
+##### What’s a change log?
+A change log is a file which contains a curated, chronologically ordered list of 
+notable changes for each version of a project.
+
+##### What’s the point of a change log?
+To make it easier for users and contributors to see precisely what notable 
+changes have been made between each release (or version) of the project.
+
+##### Why should I care?
+Because software tools are for people. If you don’t care, why are you 
+contributing? Right, Devo pay you for it, but surely, there must be a kernel
+ (ha!) of care somewhere in that lovely little brain of yours.
+
+##### What makes a good change log?
+A good change log sticks to these principles:
+
+* It’s made for humans, not machines, so legibility is crucial.
+* Easy to link to any section (hence Markdown over plain text).
+* One sub-section per version.
+* List releases in reverse-chronological order (newest on top).
+* Write all dates in `YYYY-MM-DD` format. (Example: `2012-06-02` 
+for `June 2nd, 2012`.) It’s international, sensible, and language-independent.
+* Explicitly mention whether the project follows [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+* Each version should:
+  * List its release date in the above format.
+  * Group changes to describe their impact on the project, as follows:
+  * `Added` for new features.
+  * `Changed` for changes in existing functionality.
+  * `Deprecated` for once-stable features removed in upcoming releases.
+  * `Removed` for deprecated features removed in this release.
+  * `Fixed` for any bug fixes.
+  * `Security` to invite users to upgrade in case of vulnerabilities.
+
+##### How can I minimize the effort required?
+
+Always have an `Unreleased` section at the top for keeping track of any changes.
+
+This serves two purposes:
+* People can see what changes they might expect in upcoming releases
+* At release time, you just have to change "Unreleased" to the version number and add a new "Unreleased" 
+header at the top.
+
+**Feel free for update and improve this document content or format.**<br/>
+
 
-If someone is contributing to any Devo open source repository (internal or external), a Contributor License Agreement should be signed: https://cla-assistant.io/DevoInc/
 
 ## Development
 

LICENSE

@@ -1,6 +1,6 @@
-MIT License
+The MIT License (MIT)
 
-Copyright (c) 2022 Engineering / Core Services / Machine Learning / api
+Copyright (C) 2022 Devo, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,13 +1,41 @@
 # python-mlmodelmanager
 
-A client for Devo's ML model manager
+An easy-to-use client for Devos’s Machine Learning Model Manager.
 
-## Install
+Built on top of the widely used Requests library, it takes advantage of all the 
+features it provides and exposes a simplified interface for manage models.
+
+The main purpose of this library is to allow you to focus in the machine learning 
+workflows and not worry about the integration with Devo’s ML Model Manager.
+
+## A simple example
+
+``` python
+from devo_ml.modelmanager import create_client_from_token
 
+url = "<model-manager-server-url>"
+token = "<valid-access-token>"
 
-## Usage
+client = create_client_from_token(url, token)
 
+client.add_model(
+   "pokemon_onnx_regression",          # model name
+   "ONNX",                             # model engine
+   "~/models/pokemon.onnx",            # model file
+   description="A funny Pokemon prediction"
+)
+```
+
+## Requirements
+
+* Python 3.7+
+
+## Install
 
-## Licence
+``` console
+$ pip install devo-mlmodelmanager
+```
 
+## Documentation
 
+Explore the [documentation](https://devoinc.github.io/python-mlmodelmanager-client/) to learn more.

devo_ml/modelmanager/__init__.py

@@ -1,5 +1,18 @@
-# flake8: noqa
+"""Easy-to-use ML Model Manager interface."""
 
-from .client import Client, LegacyClient
-from .client_factory import create_client_from_token, create_client_from_profile
-from .func_facade import get_models, get_model, find_model, add_model
+from ._client import Client, LegacyClient
+from ._client_factory import create_client_from_token
+from ._client_factory import create_client_from_profile
+from ._func_facade import get_models, get_model, find_model, add_model
+
+
+__all__ = [
+    "Client",
+    "LegacyClient",
+    "create_client_from_token",
+    "create_client_from_profile",
+    "get_models",
+    "get_model",
+    "find_model",
+    "add_model",
+]

devo_ml/modelmanager/client.py renamed to devo_ml/modelmanager/_client.py

@@ -1,5 +1,3 @@
-"""Clients for ML Model Manager server."""
-
 from __future__ import annotations
 
 import os
@@ -9,8 +7,8 @@
 from .auth import AuthCallable
 from .api import Api
 from .downloader import DownloaderCallable, get_default_downloader
-from .endpoint import EndpointRenderer
-from .endpoint import LatestEndpointRenderer, LegacyEndpointRenderer
+from ._endpoint import EndpointRenderer
+from ._endpoint import LatestEndpointRenderer, LegacyEndpointRenderer
 from .error import ModelManagerError, ModelNotFound, ModelAlreadyExists
 
 

devo_ml/modelmanager/client_factory.py renamed to devo_ml/modelmanager/_client_factory.py

@@ -1,7 +1,5 @@
-"""A set of convenient client factories."""
-
 from .auth import create_auth_from_token, get_default_auth_type
-from .client import Client
+from ._client import Client
 from .downloader import FileSystemDownloader
 from .profile import read_profile_from_file
 
@@ -22,7 +20,8 @@ def create_client_from_token(
     :param auth_type: The type of authentication to use;
         :const:`STANDALONE <devo_ml.modelmanager.auth.STANDALONE>` or
         :const:`BEARER <devo_ml.manager.auth.BEARER>`.
-        :func:`get_default_auth_type() <devo_ml.manager.auth.get_default_auth_type>`
+        :func:`get_default_auth_type()
+        <devo_ml.manager.auth.get_default_auth_type>`
         is used if is not provided
     :param download_path: The path where model files will be downloaded. The
         current directory ``.`` is used if not provided.

devo_ml/modelmanager/endpoint.py renamed to devo_ml/modelmanager/_endpoint.py

@@ -1,5 +1,3 @@
-"""The ways that endpoints of ML Model Manager can be render."""
-
 from __future__ import annotations
 
 import abc