Merge pull request #30 from dayyass/add_pip

add pip install

Author: dayyass

.coveragerc

@@ -1,6 +1,6 @@
 [run]
 branch = True
-source = muse_as_service
+source = src
 
 [report]
 exclude_lines =
@@ -11,9 +11,9 @@ exclude_lines =
     if __name__ == .__main__.:
 
 omit =
-    muse_as_service/utils.py
-    muse_as_service/database/add_user.py
-    muse_as_service/database/remove_user.py
+    src/muse_as_service/utils.py
+    src/muse_as_service/database/add_user.py
+    src/muse_as_service/database/remove_user.py
 
 show_missing = True
 ignore_errors = False

.dockerignore

@@ -13,8 +13,11 @@
 
 venv
 .idea
+dist
 .git
 
+src/muse_as_service.egg-info/
+
 models/*
 !models/README.md
 !models/download_muse.py

.gitignore

@@ -13,6 +13,9 @@
 
 venv
 .idea
+dist
+
+src/muse_as_service.egg-info/
 
 models/*
 !models/README.md

README.md

@@ -1,12 +1,17 @@
 [![tests](https://github.com/dayyass/muse_as_service/actions/workflows/tests.yml/badge.svg)](https://github.com/dayyass/muse_as_service/actions/workflows/tests.yml)
 [![linter](https://github.com/dayyass/muse_as_service/actions/workflows/linter.yml/badge.svg)](https://github.com/dayyass/muse_as_service/actions/workflows/linter.yml)
 [![codecov](https://codecov.io/gh/dayyass/muse_as_service/branch/main/graph/badge.svg?token=RRSTQY2R2Y)](https://codecov.io/gh/dayyass/muse_as_service)
+
 [![python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://github.com/dayyass/muse_as_service#requirements)
-[![license](https://img.shields.io/github/license/dayyass/muse_as_service)](https://github.com/dayyass/muse_as_service/blob/main/LICENSE)
 [![release (latest by date)](https://img.shields.io/github/v/release/dayyass/muse_as_service)](https://github.com/dayyass/muse_as_service/releases/latest)
-[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/dayyass/muse_as_service/blob/main/.pre-commit-config.yaml)
+[![license](https://img.shields.io/github/license/dayyass/muse_as_service?color=blue)](https://github.com/dayyass/muse_as_service/blob/main/LICENSE)
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-black)](https://github.com/dayyass/muse_as_service/blob/main/.pre-commit-config.yaml)
 [![code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
+[![pypi version](https://img.shields.io/pypi/v/muse-as-service)](https://pypi.org/project/muse-as-service/1.1.0/)
+[![pypi downloads](https://img.shields.io/pypi/dm/muse-as-service)](https://pypi.org/project/muse-as-service/1.1.0/)
+
 ### What is MUSE?
 **MUSE** stands for Multilingual Universal Sentence Encoder - multilingual extension (supports [16 languages](https://github.com/dayyass/muse_as_service#muse-supported-languages)) of Universal Sentence Encoder (USE).<br>
 MUSE model encodes sentences into embedding vectors of fixed size.
@@ -86,21 +91,21 @@ MUSE as Service supports **GPU** inference. To launch the service with GPU suppo
 ### Usage
 Since the service is usually running on server, it is important to restrict access to the service.
 
-For this reason, MUSE as Service uses **token-based authorization** with [JWT](https://jwt.io) for users in sqlite database [app.db](https://github.com/dayyass/muse_as_service/tree/main/muse_as_service/database/app.db).
+For this reason, MUSE as Service uses **token-based authorization** with [JWT](https://jwt.io) for users in sqlite database [app.db](https://github.com/dayyass/muse_as_service/tree/main/src/muse_as_service/database/app.db).
 
 Initially database has only one user with:
 - **username**: "admin"
 - **password**: "admin"
 
 To add new user with `username` and `password` run:
 ```shell script
-python muse_as_service/database/add_user.py --username {username} --password {password}
+python src/muse_as_service/database/add_user.py --username {username} --password {password}
 ```
 **NOTE**: no passwords are stored in the database, only their hashes.
 
 To remove the user with `username` run:
 ```shell script
-python muse_as_service/database/remove_user.py --username {username}
+python src/muse_as_service/database/remove_user.py --username {username}
 ```
 
 MUSE as Service has the following endpoints:
@@ -164,6 +169,11 @@ print(embedding.shape)  # (2, 512)
 
 However it is better to use built-in client **MUSEClient** for sentence tokenization and embedding, that wraps the functionality of the python **requests** package and provides user with a simpler interface.
 
+To install the built-in client run:<br>
+`
+pip install muse-as-service
+`
+
 Instead of using endpoints, listed above, directly, **MUSEClient** provides the following methods to work with:
 <pre>
 - login    - method to login with `username` and `password`

app.py

@@ -1,5 +1,5 @@
-from muse_as_service.app import app
-from muse_as_service.utils import get_argparse
+from src.muse_as_service.app import app
+from src.muse_as_service.utils import get_argparse
 
 if __name__ == "__main__":
 

codecov.yml

@@ -2,16 +2,16 @@ codecov:
   require_ci_to_pass: yes
 
 ignore:
-  - "muse_as_service/utils.py"
-  - "muse_as_service/database/add_user.py"
-  - "muse_as_service/database/remove_user.py"
+  - "src/muse_as_service/utils.py"
+  - "src/muse_as_service/database/add_user.py"
+  - "src/muse_as_service/database/remove_user.py"
 
 coverage:
   status:
     project:
       default: false
       source:
         paths:
-          - "muse_as_service/"
+          - "src/"
         target: 90%
     patch: off

examples/usage_client.py

@@ -1,8 +1,4 @@
-import sys
-
-sys.path.append("../muse_as_service")
-
-from muse_as_service import MUSEClient  # noqa: E402
+from muse_as_service import MUSEClient
 
 # params
 ip = "localhost"

muse_as_service/__init__.py

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"

muse_as_service/client/__init__.py

@@ -0,0 +1,24 @@
+[metadata]
+name = muse-as-service
+version = 1.1.0
+author = Dani El-Ayyass
+author_email = dayyass@yandex.ru
+description = REST API for sentence tokenization and embedding using Multilingual Universal Sentence Encoder
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/dayyass/muse_as_service
+project_urls =
+    Bug Tracker = https://github.com/dayyass/muse_as_service/issues
+classifiers =
+    Programming Language :: Python :: 3
+    License :: OSI Approved :: MIT License
+    Operating System :: OS Independent
+
+[options]
+package_dir =
+    = src
+packages = find:
+python_requires = >=3.7
+
+[options.packages.find]
+where = src

muse_as_service/database/__init__.py

@@ -1,7 +1,7 @@
 ### MUSE as Service
 This module contains:
-- REST API [endpoints](https://github.com/dayyass/muse_as_service/blob/main/muse_as_service/endpoints.py) for MUSE embedder and tokenizer
-- REST API [endpoints](https://github.com/dayyass/muse_as_service/blob/main/muse_as_service/auth.py) for authorization
-- SQLite [database](https://github.com/dayyass/muse_as_service/blob/main/muse_as_service/database)
-- Flask [app](https://github.com/dayyass/muse_as_service/blob/main/muse_as_service/app.py)
-- MUSE [client](https://github.com/dayyass/muse_as_service/blob/main/muse_as_service/client)
+- REST API [endpoints](https://github.com/dayyass/muse_as_service/blob/main/src/muse_as_service/endpoints.py) for MUSE embedder and tokenizer
+- REST API [endpoints](https://github.com/dayyass/muse_as_service/blob/main/src/muse_as_service/auth.py) for authorization
+- SQLite [database](https://github.com/dayyass/muse_as_service/blob/main/src/muse_as_service/database)
+- Flask [app](https://github.com/dayyass/muse_as_service/blob/main/src/muse_as_service/app.py)
+- MUSE [client](https://github.com/dayyass/muse_as_service/blob/main/src/muse_as_service/client)

muse_as_service/tokenizer/__init__.py

@@ -0,0 +1,4 @@
+from .client import MUSEClient
+
+__version__ = "1.1.0"
+__all__ = ["MUSEClient"]

pyproject.toml

@@ -14,8 +14,8 @@
 jwt: JWTManager = JWTManager(app)
 
 
-from muse_as_service.auth import TokenRefresh, UserLogin, UserLogout  # noqa: E402
-from muse_as_service.endpoints import Embedder, Tokenizer  # noqa: E402
+from .auth import TokenRefresh, UserLogin, UserLogout  # noqa: E402
+from .endpoints import Embedder, Tokenizer  # noqa: E402
 
 # auth
 api.add_resource(UserLogin, "/login")

setup.cfg

@@ -10,7 +10,7 @@
 )
 from flask_restful import Resource, reqparse
 
-from muse_as_service.database.database import UserModel
+from .database import UserModel
 
 
 def unauthorized() -> Response:

muse_as_service/README.md src/muse_as_service/README.md

@@ -60,6 +60,11 @@ print(embedding.shape)  # (2, 512)
 
 However it is better to use built-in client **MUSEClient** for sentence tokenization and embedding, that wraps the functionality of the python **requests** package and provides user with a simpler interface.
 
+To install the built-in client run:<br>
+`
+pip install muse-as-service
+`
+
 Instead of using endpoints, listed above, directly, **MUSEClient** provides the following methods to work with:
 <pre>
 - login         - method to login with `username` and `password`

src/muse_as_service/__init__.py

@@ -0,0 +1,3 @@
+from .client import MUSEClient
+
+__all__ = ["MUSEClient"]

muse_as_service/app.py src/muse_as_service/app.py

@@ -1,22 +1,22 @@
 ### Database
 Since the service is usually running on the server, it is important to restrict access to the service.
 
-For this reason, MUSE as Service uses **token-based authorization** with [JWT](https://jwt.io) for users in sqlite database [app.db](https://github.com/dayyass/muse_as_service/tree/main/muse_as_service/database/app.db).
+For this reason, MUSE as Service uses **token-based authorization** with [JWT](https://jwt.io) for users in sqlite database [app.db](https://github.com/dayyass/muse_as_service/tree/main/src/muse_as_service/database/app.db).
 
 Initially database has only one user with:
 - **username**: "admin"
 - **password**: "admin"
 
 To add new user with `username` and `password` run:
 ```
-python muse_as_service/database/add_user.py --username {username} --password {password}
+python src.muse_as_service/database/add_user.py --username {username} --password {password}
 ```
 **NOTE**: run it from parent directory `muse_as_service`
 
 **NOTE**: no passwords are stored in the database, only their hashes.
 
 To remove the user with `username` run:
 ```
-python muse_as_service/database/remove_user.py --username {username}
+python src.muse_as_service/database/remove_user.py --username {username}
 ```
 **NOTE**: run it from parent directory `muse_as_service`

muse_as_service/auth.py src/muse_as_service/auth.py

@@ -0,0 +1,3 @@
+from .database import UserModel
+
+__all__ = ["UserModel"]

muse_as_service/client/README.md src/muse_as_service/client/README.md

@@ -1,10 +1,20 @@
 import sqlite3
-import sys
 from argparse import ArgumentParser
 from contextlib import closing
 
-sys.path.append(".")
-from database import UserModel  # noqa: E402
+from passlib.hash import pbkdf2_sha256 as sha256
+
+
+def generate_hash(password: str) -> str:
+    """
+    Generate hash for password.
+
+    :param str password: password.
+    :return: hash.
+    :rtype: str
+    """
+
+    return sha256.hash(password)
 
 
 def get_argparse() -> ArgumentParser:
@@ -30,10 +40,10 @@ def get_argparse() -> ArgumentParser:
     parser = get_argparse()
     args = parser.parse_args()
 
-    insert_query = f'INSERT INTO users (username, password) VALUES ("{args.username}", "{UserModel.generate_hash(args.password)}");'
+    insert_query = f'INSERT INTO users (username, password) VALUES ("{args.username}", "{generate_hash(args.password)}");'
 
     # sqlite
-    with closing(sqlite3.connect("muse_as_service/database/app.db")) as conn:
+    with closing(sqlite3.connect("src/muse_as_service/database/app.db")) as conn:
         with closing(conn.cursor()) as cursor:
             cursor.execute(insert_query)
             conn.commit()

src/muse_as_service/client/__init__.py

@@ -2,7 +2,7 @@
 
 from passlib.hash import pbkdf2_sha256 as sha256
 
-from muse_as_service.app import db
+from ...muse_as_service.app import db
 
 
 class UserModel(db.Model):

muse_as_service/client/client.py src/muse_as_service/client/client.py

@@ -1,10 +1,7 @@
 import sqlite3
-import sys
 from argparse import ArgumentParser
 from contextlib import closing
 
-sys.path.append(".")
-
 
 def get_argparse() -> ArgumentParser:
     """
@@ -29,7 +26,7 @@ def get_argparse() -> ArgumentParser:
     delete_query = f"DELETE FROM users WHERE username = '{args.username}';"
 
     # sqlite
-    with closing(sqlite3.connect("muse_as_service/database/app.db")) as conn:
+    with closing(sqlite3.connect("src/muse_as_service/database/app.db")) as conn:
         with closing(conn.cursor()) as cursor:
             cursor.execute(delete_query)
             conn.commit()

muse_as_service/config.py src/muse_as_service/config.py

@@ -3,11 +3,7 @@
 from flask_jwt_extended import jwt_required
 from flask_restful import Resource, reqparse
 
-from muse_as_service.tokenizer.tokenizer import (
-    get_tokenizer_from_saved_model,
-    parse_saved_model,
-    tokenize,
-)
+from .tokenizer import get_tokenizer_from_saved_model, parse_saved_model, tokenize
 
 
 def get_sentence_parser() -> reqparse.RequestParser:

muse_as_service/database/README.md src/muse_as_service/database/README.md

@@ -0,0 +1,7 @@
+from .tokenizer import get_tokenizer_from_saved_model, parse_saved_model, tokenize
+
+__all__ = [
+    "get_tokenizer_from_saved_model",
+    "parse_saved_model",
+    "tokenize",
+]

src/muse_as_service/database/__init__.py

@@ -5,8 +5,8 @@
 import requests
 from flask import Flask
 
-from muse_as_service import MUSEClient
-from muse_as_service.app import app
+from src.muse_as_service import MUSEClient
+from src.muse_as_service.app import app
 
 
 class TestAuth(flask_testing.TestCase):

muse_as_service/database/add_user.py src/muse_as_service/database/add_user.py

@@ -1,7 +1,7 @@
 import unittest
 
-from muse_as_service.app import app  # noqa: F401
-from muse_as_service.database.database import UserModel
+from src.muse_as_service.app import app  # noqa: F401
+from src.muse_as_service.database import UserModel
 
 
 class TestDatabase(unittest.TestCase):

muse_as_service/database/app.db src/muse_as_service/database/app.db

@@ -4,8 +4,8 @@
 import numpy as np
 from flask import Flask
 
-from muse_as_service import MUSEClient
-from muse_as_service.app import app
+from src.muse_as_service import MUSEClient
+from src.muse_as_service.app import app
 
 
 class TestUsage(flask_testing.TestCase):