From 3eaa53504c8f1ab2416edcccff3db8dee797cac0 Mon Sep 17 00:00:00 2001 From: arturlazarenkoemnify Date: Wed, 13 Jul 2022 02:54:18 +0200 Subject: [PATCH 1/3] feat: release-ready fixes --- .github/workflows/bump-version.yml | 4 ++-- README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/bump-version.yml b/.github/workflows/bump-version.yml index 285d11d..623b7fb 100644 --- a/.github/workflows/bump-version.yml +++ b/.github/workflows/bump-version.yml @@ -7,8 +7,8 @@ on: jobs: bump: env: - RELEASE_REPOSITORY: testpypi - RELEASE_PACKAGE_NAME: emnify-sdk-test-beta + RELEASE_REPOSITORY: pypi + RELEASE_PACKAGE_NAME: emnify-sdk RELEASE_PYPI_TOKEN: ${{secrets.PYPI_RELEASE_TOKEN}} name: Bump and Release # Prevent circular workflow run diff --git a/README.md b/README.md index b9bc7e2..dbb4cf6 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,10 @@ Automate your routines with this SDK for Python. - Install from source > git clone https://github.com/emnify-python-sdk.git -> cd emnify-python-sdk +> cd emnify-sdk > python setup.py install - or install with pip -> pip install emnify-python-sdk +> pip install emnify-sdk ## Documentation From 81382366b26272844835947d3b3ac5d534cd5a3e Mon Sep 17 00:00:00 2001 From: arturlazarenkoemnify Date: Wed, 13 Jul 2022 09:56:16 +0200 Subject: [PATCH 2/3] feat: changing pypi naming --- docs/sphinx/getting_started.rst | 2 +- setup.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/getting_started.rst b/docs/sphinx/getting_started.rst index 77e86af..19fb2ce 100644 --- a/docs/sphinx/getting_started.rst +++ b/docs/sphinx/getting_started.rst @@ -22,7 +22,7 @@ Install via PyPi .. code-block:: bash :caption: Installation commands - pip install emnify-python-sdk + pip install emnify-sdk Configure --------- diff --git a/setup.py b/setup.py index 80e0876..568b7cb 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ from setuptools import setup, find_packages import os -NAME = os.getenv('PYPI_PACKAGE_NAME') or "emnify-python-sdk" +NAME = os.getenv('PYPI_PACKAGE_NAME') or "emnify-sdk" VERSION = "0.0.16" # To install the library, run the following # From 93cc2889a927d2a937a76de9a9aadd421529b06b Mon Sep 17 00:00:00 2001 From: Mikhail G Date: Tue, 6 Sep 2022 11:43:23 +0200 Subject: [PATCH 3/3] cleanup and extend dev docs --- .github/dependabot.yml | 5 +++-- DEVELOPMENT.md | 6 ++++++ README.md | 15 ++++++++------- docs/sphinx/getting_started.rst | 4 ++-- 4 files changed, 19 insertions(+), 11 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 4e63a6c..1509cad 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -6,14 +6,15 @@ updates: target-branch: development commit-message: prefix: 'build' - include_scope: true + prefix-development: 'build' + include: "scope" schedule: interval: "daily" - package-ecosystem: "github-actions" directory: "/" commit-message: prefix: 'ci' - include_scope: true + include: "scope" schedule: interval: "daily" ignore: diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 2a7330e..44acd64 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -21,3 +21,9 @@ docker run -t -v $(pwd):/sdk emnify/python-sdk pytest --cov=emnify --cov-fail-un ```shell bump2version minor ``` + +## Branching and PR + +PR names must follow [angular convention](https://github.com/angular/angular/blob/main/CONTRIBUTING.md). + +Squash changes while merging to `development` and do regular merge to `main`. diff --git a/README.md b/README.md index dbb4cf6..48acb04 100644 --- a/README.md +++ b/README.md @@ -13,15 +13,16 @@ Automate your routines with this SDK for Python. `Python > 3.6` is **required**. - - - Install from source -> git clone https://github.com/emnify-python-sdk.git -> cd emnify-sdk -> python setup.py install +```shell +git clone https://github.com/emnify-python-sdk.git emnify-sdk +cd emnify-sdk +python setup.py install +``` - or install with pip -> pip install emnify-sdk - +```shell +pip install emnify-sdk +``` ## Documentation diff --git a/docs/sphinx/getting_started.rst b/docs/sphinx/getting_started.rst index 19fb2ce..0ec0dcb 100644 --- a/docs/sphinx/getting_started.rst +++ b/docs/sphinx/getting_started.rst @@ -13,8 +13,8 @@ Install From Source Code .. code-block:: bash :caption: Installation commands - git clone https://github.com/emnify-python-sdk.git - cd emnify-python-sdk + git clone https://github.com/emnify-python-sdk.git emnify-sdk + cd emnify-sdk python setup.py install Install via PyPi