Merge pull request #12 from Riminder/feature/use-poetry

Migrate to Poetry and Pytest

Author: corentin-hrflow

.env.example

@@ -0,0 +1,11 @@
+HRFLOW_API_KEY="___FILL_ME___"
+HRFLOW_API_KEY_READ="___FILL_ME___"
+HRFLOW_USER_EMAIL="___FILL_ME___"
+HRFLOW_ALGORITHM_KEY="___FILL_ME___"
+HRFLOW_BOARD_KEY="___FILL_ME___"
+HRFLOW_JOB_KEY="___JOB_KEY_IN_BOARD___"
+HRFLOW_PROFILE_KEY="___PROFILE_KEY_IN_SOURCE_QUICKSILVER_SYNC___"
+HRFLOW_SOURCE_KEY_HAWK_SYNC="___FILL_ME___"
+HRFLOW_SOURCE_KEY_QUICKSILVER_SYNC="___FILL_ME___"
+HRFLOW_SOURCE_KEY_QUICKSILVER_ASYNC="___FILL_ME___"
+HRFLOW_SOURCE_KEY_MOZART_ASYNC="___FILL_ME___"

.flake8

@@ -0,0 +1,6 @@
+[flake8]
+max-line-length = 88
+exclude = .pytest_cache, __pycache__, .env, .venv
+black-config = pyproject.toml
+per-file-ignores = __init__.py:F401
+ignore = E731, W503, E203

.gitignore

@@ -1,3 +1,6 @@
+# Env
+.env
+
 # Datas
 *.png
 *.jpg
@@ -9,6 +12,7 @@ credentials
 credentials_seg
 test/*
 test_assets/*
+tests/assets
 .htpasswd
 
 docker/dependencies/libs/*

LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) [year] [fullname]
+Copyright (c) 2023 HrFlow.ai
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -1,20 +1,30 @@
 # Define variables
 ARGS := 
 
-install_req:
-	pip install -U setuptools setuptools_scm wheel && python -m pip install twine
-
 clean:
 	rm -rf build dist *.egg-info
 
+clean_cache:
+	find . -type d \( -name '__pycache__' -o -name '.pytest_cache' \) -exec rm -rf {} +
+	rm -rf tests/assets
+
 build:
-	python setup.py sdist bdist_wheel
+	poetry build
 
 git-tag:
 	./tag.sh $(ARGS)
 
 deploy-test:
-	python -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+	poetry publish -r test-pypi --build
 
 deploy:
-	python -m twine upload dist/*
+	poetry publish --build
+
+flake8:
+	poetry run flake8 --config=./.flake8
+
+style:
+	poetry run isort . && poetry run black --config=./pyproject.toml .
+
+check:
+	bash ./check.sh

README.md

@@ -56,7 +56,7 @@ Install using `pip install -U hrflow` or `conda install hrflow -c conda-forge`.
 
 ```py
 from hrflow import Hrflow
-client = Hrflow(api_secret="YOUR_API_KEY"; api_user="YOU_USER_EMAIL")
+client = Hrflow(api_secret="YOUR_API_KEY", api_user="YOU_USER_EMAIL")
 
 # read file from directory (in binary mode) 
 with open("path_to_file.pdf", "rb") as f:

README.rst

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+PYTEST_RUN="poetry run pytest"
+PYTEST_OPTIONS=(--verbose --tb=long --strict-markers --durations=0 --datefmt "%Y-%m-%d %H:%M:%S.%f%z")
+PYTEST_DIR=tests/
+
+if [ "$#" -gt 0 ]; then
+    for marker in "$@"; do
+        $PYTEST_RUN "${PYTEST_OPTIONS[@]}" "$PYTEST_DIR" -m "$marker"
+    done
+else
+    $PYTEST_RUN "${PYTEST_OPTIONS[@]}" "$PYTEST_DIR"
+fi

check.sh

@@ -1,4 +1,10 @@
+from .__version__ import (
+    __author__,
+    __author_email__,
+    __description__,
+    __license__,
+    __title__,
+    __url__,
+    __version__,
+)
 from .hrflow.hrflow import Hrflow
-
-from .__version__ import __title__, __description__, __url__, __version__
-from .__version__ import __author__, __author_email__, __license__

hrflow/__init__.py

@@ -1,7 +1,9 @@
+import importlib.metadata
+
 __title__ = "hrflow"
 __description__ = "Python hrflow.ai API package"
 __url__ = "https://github.com/hrflow/python-hrflow-api"
-__version__ = "3.1.1"
+__version__ = importlib.metadata.version("hrflow")
 __author__ = "HrFlow.ai"
 __author_email__ = "contact@hrflow.ai"
 __license__ = "MIT"