refactor(replace python dependcy management tool setup.py to poetry): refactor code

Author: kenessajr

.coveragerc

@@ -1,2 +1,5 @@
 [run]
-omit = */test_*.py
+omit =
+     */tests/*
+     */site-packages/*
+     */distutils/*

.github/workflows/build.yaml renamed to .github/workflows/ci.yaml

@@ -11,13 +11,6 @@ defaults:
     shell: bash
 
 jobs:
-  black-formatting-check:
-    name: Check formatting
-    runs-on: 'ubuntu-latest'
-    steps:
-      - uses: actions/checkout@v2.3.4
-      - uses: actions/setup-python@v2.2.2
-      - uses: psf/black@stable
   build:
     name: Build tool
     runs-on: ${{ matrix.os }}
@@ -74,5 +67,18 @@ jobs:
           poetry install --no-interaction
       - name: Run tests
         run: poetry run pytest -v
-      - name: Build artifacts
-        run: poetry build
+
+  Release:
+    needs: build
+    # https://github.community/t/how-do-i-specify-job-dependency-running-in-another-workflow/16482
+    if: github.event_name == 'push' && github.ref == 'refs/heads/master' && !contains(github.event.head_commit.message, 'chore(release):')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Python Semantic Release
+        uses: relekang/python-semantic-release@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          pypi_token: ${{ secrets.PYPI_TOKEN }}

pindo_cli/__init__.py

@@ -1,96 +1 @@
-import click
-import click_spinner
-
-from pindo_cli.http import Token, RefreshToken, Register, SMS, Balance, Organization
-
-
-@click.group()
-@click.option('--debug/--no-debug', default=False)
-@click.version_option(None, "--version", "-v")
-def cli(debug):
-    """
-    Pindo CLI
-    A simple Command Line Interface that allow you to create an account
-    and request a token for using Pindo API
-    """
-
-
-@cli.command()  # @cli, not @click!
-@click.option(
-    '--username', '-u', prompt=True, help='Please enter your username')
-@click.option(
-    '--password', '-p',
-    prompt=True, hide_input=True, help='Please enter your password')
-def token(username, password):
-    """
-    Request a token for using Pindo API.
-    """
-    click.echo('token...')
-    with click_spinner.spinner():
-        click.echo(Token(username, password))
-
-
-@cli.command()  # @cli, not @click!
-@click.option(
-    '--username', '-u', prompt=True, help='Please enter your username')
-@click.option(
-    '--password', '-p',
-    prompt=True, hide_input=True, help='Please enter your password')
-def refresh_token(username, password):
-    """
-    Refresh a Token.
-    """
-    click.echo('token...')
-    with click_spinner.spinner():
-        click.echo(RefreshToken(username, password))
-
-
-@cli.command()
-@click.option(
-    '--username', '-u', prompt=True, help='Please enter your username')
-@click.option(
-    '--email', '-e', prompt=True, help='Please enter your email')
-@click.option(
-    '--password', '-p', prompt=True, hide_input=True, confirmation_prompt=True,
-    help='Please enter your password')
-def register(username, email, password):
-    """
-    Create a new Pindo account.
-    """
-    click.echo(Register(username, email, password))
-
-
-@cli.command()
-@click.option('--token', prompt=True, help='API Token')
-@click.option(
-    '--to', prompt=True, help='Receiver phone number (+250xxxxxx)',
-    default='+250785383100')
-@click.option(
-    '--text', prompt=True, help='Message to send', default='Hello Pindo')
-@click.option('--sender', prompt=True, default='Pindo', help='Sender name')
-def sms(token, to, text, sender):
-    """
-    Send a test message
-    """
-    click.echo(SMS(token, to, text, sender))
-
-
-@cli.command()
-@click.option('--token', prompt=True, help='API Token')
-def balance(token):
-    """
-    Get account balance
-    """
-    click.echo(Balance(token))
-
-
-@cli.command()
-@click.option('--token', prompt=True, help='API Token')
-@click.option('--name', prompt=True, help='Organization name')
-@click.option('--webhook_url', prompt=True, help='Webhook URL. Eg (https://pindo.io/dlr)')
-@click.option('--retries_count', prompt=True, type=(int), help='SMS retries count settings')
-def org(token, name, webhook_url, retries_count):
-    """
-    Organization
-    """
-    click.echo(Organization(token, name, webhook_url, retries_count))
+__version__ = '0.1.0'

pindo_cli/cli.py

@@ -0,0 +1,96 @@
+import click
+import click_spinner
+
+from pindo_cli.http import Token, RefreshToken, Register, SMS, Balance, Organization
+
+
+@click.group()
+@click.option('--debug/--no-debug', default=False)
+@click.version_option(None, "--version", "-v")
+def cli(debug):
+    """
+    Pindo CLI
+    A simple Command Line Interface that allow you to create an account
+    and request a token for using Pindo API
+    """
+
+
+@cli.command()  # @cli, not @click!
+@click.option(
+    '--username', '-u', prompt=True, help='Please enter your username')
+@click.option(
+    '--password', '-p',
+    prompt=True, hide_input=True, help='Please enter your password')
+def token(username, password):
+    """
+    Request a token for using Pindo API.
+    """
+    click.echo('token...')
+    with click_spinner.spinner():
+        click.echo(Token(username, password))
+
+
+@cli.command()  # @cli, not @click!
+@click.option(
+    '--username', '-u', prompt=True, help='Please enter your username')
+@click.option(
+    '--password', '-p',
+    prompt=True, hide_input=True, help='Please enter your password')
+def refresh_token(username, password):
+    """
+    Refresh a Token.
+    """
+    click.echo('token...')
+    with click_spinner.spinner():
+        click.echo(RefreshToken(username, password))
+
+
+@cli.command()
+@click.option(
+    '--username', '-u', prompt=True, help='Please enter your username')
+@click.option(
+    '--email', '-e', prompt=True, help='Please enter your email')
+@click.option(
+    '--password', '-p', prompt=True, hide_input=True, confirmation_prompt=True,
+    help='Please enter your password')
+def register(username, email, password):
+    """
+    Create a new Pindo account.
+    """
+    click.echo(Register(username, email, password))
+
+
+@cli.command()
+@click.option('--token', prompt=True, help='API Token')
+@click.option(
+    '--to', prompt=True, help='Receiver phone number (+250xxxxxx)',
+    default='+250785383100')
+@click.option(
+    '--text', prompt=True, help='Message to send', default='Hello Pindo')
+@click.option('--sender', prompt=True, default='Pindo', help='Sender name')
+def sms(token, to, text, sender):
+    """
+    Send a test message
+    """
+    click.echo(SMS(token, to, text, sender))
+
+
+@cli.command()
+@click.option('--token', prompt=True, help='API Token')
+def balance(token):
+    """
+    Get account balance
+    """
+    click.echo(Balance(token))
+
+
+@cli.command()
+@click.option('--token', prompt=True, help='API Token')
+@click.option('--name', prompt=True, help='Organization name')
+@click.option('--webhook_url', prompt=True, help='Webhook URL. Eg (https://pindo.io/dlr)')
+@click.option('--retries_count', prompt=True, type=(int), help='SMS retries count settings')
+def org(token, name, webhook_url, retries_count):
+    """
+    Organization
+    """
+    click.echo(Organization(token, name, webhook_url, retries_count))

poetry.toml

@@ -0,0 +1,2 @@
+[virtualenvs]
+in-project = true

pyproject.toml

@@ -24,18 +24,15 @@ packages = [
     { include = "pindo_cli" }
 ]
 
-[tool.black]
-exclude = '''
-/(
-    \.eggs
-  | \.git
-  | \.venv
-  | \.env
-  | build
-  | dist
-  | \.mypy_cache
-)\
-'''
+[tool.semantic_release]
+version_variable = [
+    "pindo_cli/__init__.py:__version__",
+    "pyproject.toml:version"
+]
+branch = "master"
+upload_to_pypi = true
+upload_to_release = true
+build_command = "pip install poetry && poetry build"
 
 [tool.poetry.dependencies]
 python = "^3.7"
@@ -52,10 +49,9 @@ tomlkit = "^0.7.0"
 coverage = {version = "^5.5", extras = ["toml"]}
 flake8 = "^3.9.2"
 flake8-bugbear = "^21.4.3"
-black = "^21.5b0"
 
 [tool.coverage.run]
-omit = [".*", "*/site-packages/*"]
+omit = [".*", "*/site-packages/*", "*/distutils/*", "*/tests/*"]
 
 [tool.coverage.report]
 fail_under = 100
@@ -65,4 +61,4 @@ requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry.scripts]
-pindo = 'pindo_cli:cli'
+pindo = 'pindo_cli.cli:cli'

tests/test_cli.py

@@ -2,7 +2,7 @@
 from click.testing import CliRunner
 from pkg_resources import get_distribution
 
-import pindo_cli
+import pindo_cli.cli as pindo
 
 
 @pytest.fixture(scope="module")
@@ -11,34 +11,34 @@ def runner():
 
 
 def test_pindo_cli(runner):
-    result = runner.invoke(pindo_cli.cli, ['--help'])
+    result = runner.invoke(pindo.cli, ['--help'])
     assert result.exit_code == 0
     assert 'Pindo CLI' in result.output
 
 
 def test_command_token(runner):
-    result = runner.invoke(pindo_cli.token, ['-u', 'abc', '-p', 'cbd'])
+    result = runner.invoke(pindo.token, ['-u', 'abc', '-p', 'cbd'])
     assert result.exit_code == 0
     assert 'message' in result.output
 
 
 def test_command_refresh_token(runner):
-    result = runner.invoke(pindo_cli.refresh_token, ['-u', 'abc', '-p', 'cbd'])
+    result = runner.invoke(pindo.refresh_token, ['-u', 'abc', '-p', 'cbd'])
     assert result.exit_code == 0
     assert 'message' in result.output
 
 
 def test_command_register(runner):
     result = runner.invoke(
-        pindo_cli.register,
+        pindo.register,
         ['-u', 'ken', '-e', 'remy@bar.io', '-p', 'bar'])
     assert result.exit_code == 0
     assert 'message' in result.output
 
 
 def test_command_sms(runner):
     result = runner.invoke(
-        pindo_cli.sms, [
+        pindo.sms, [
             '--token', 'oeiroeoeioeoiroe',
             '--to', '+250785383100',
             '--text', 'Hello Pindo',
@@ -50,22 +50,22 @@ def test_command_sms(runner):
 
 def test_command_(runner):
     result = runner.invoke(
-        pindo_cli.balance, [
+        pindo.balance, [
             '--token', 'oeiroeoeioeoiroe',
         ])
     assert result.exit_code == 0
     assert 'message' in result.output
 
 
 def test_pindo_cli_version_flag(runner):
-    result = runner.invoke(pindo_cli.cli, ['--version', "-v"])
+    result = runner.invoke(pindo.cli, ['--version', "-v"])
     assert result.exit_code == 0
     assert get_distribution('pindo-cli').version in result.output
 
 
 def test_command_org(runner):
     result = runner.invoke(
-        pindo_cli.org, [
+        pindo.org, [
             '--token', 'oeiroeoeioeoiroe',
             '--name', 'Pindo',
             '--webhook_url', 'https://pindo.io/webhook',