Release version 0.1.0

.github/workflows/deployment.yml

@@ -12,10 +12,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v3
-    - name: Set up Python 3.10
+    - name: Set up Python 3.11
       uses: actions/setup-python@v3
       with:
-        python-version: "3.10"
+        python-version: "3.11"
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -35,35 +35,40 @@ jobs:
     - name: Code Security Check
       run: |
         ./scripts/code-security-check.sh
+    - name: Get Latest tag
+      run: |
+        git fetch --tags
+        LATEST_TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
+        echo "LATEST_TAG: $LATEST_TAG"
+        echo "LATEST_TAG=$LATEST_TAG" >> $GITHUB_ENV
+    - name: Extract version
+      run: |
+        NEW_VERSION=$(grep '^__version__' "pyepp/__init__.py" | sed -E 's/^__version__ = "(.*)"/v\1/')
+        echo "NEW_VERSION: $NEW_VERSION"
+        echo "NEW_VERSION=$NEW_VERSION" >> $GITHUB_ENV
+        TRIMMED_VERSION=$(echo "$NEW_VERSION" | sed 's/^v//')
+        echo "TRIMMED_VERSION=$TRIMMED_VERSION" >> $GITHUB_ENV
     - name: Publish to TestPyPi
-      if: github.event_name == 'push' && github.ref == 'refs/heads/develop'
+      if: github.event_name == 'push' && github.ref == 'refs/heads/develop' && env.LATEST_TAG != env.NEW_VERSION
       run: |
         rm -rf dist
         python -m build
         twine check dist/*
         twine upload -r testpypi --username __token__ --password ${{ secrets.TEST_PYPI_API_TOKEN }} --skip-existing dist/*
     - name: Publish to PyPi
-      if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+      if: github.event_name == 'push' && github.ref == 'refs/heads/main' && env.LATEST_TAG != env.NEW_VERSION
       run: |
         rm -rf dist
         python -m build
         twine check dist/*
-        twine upload --username __token__ --password ${{ secrets.PYPI_API_TOKEN }} dist/*
-    - name: Extract version
-      run: |
-        NEW_VERSION=$(grep '^__version__' "pyepp/__init__.py" | sed -E 's/^__version__ = "(.*)"/v\1/')
-        echo "NEW_VERSION: $NEW_VERSION"
-        echo "NEW_VERSION=$NEW_VERSION" >> $GITHUB_ENV
-    - name: Get Previous tag
-      id: previous_tag
-      uses: "WyriHaximus/github-action-get-previous-tag@v1"
+        twine upload --username __token__ --password ${{ secrets.PYPI_API_TOKEN }} dist/* 
     - name: Create Tag
-      if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-      uses: rickstaa/action-create-tag@v1.7.2
-      with:
-        tag: ${{env.NEW_VERSION}}
+      if: github.event_name == 'push' && github.ref == 'refs/heads/main' && env.LATEST_TAG != env.NEW_VERSION
+      run: |
+        git tag ${{env.NEW_VERSION}}
+        git push origin ${{env.NEW_VERSION}}
     - name: Generate changelog
-      if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+      if: github.event_name == 'push' && github.ref == 'refs/heads/main' && env.LATEST_TAG != env.NEW_VERSION
       id: build_changelog
       uses: mikepenz/release-changelog-builder-action@v4
       with:
@@ -89,13 +94,16 @@ jobs:
         toTag: ${{env.NEW_VERSION}}
         token: ${{ secrets.GITHUB_TOKEN }}
     - name: Create release
-      if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+      if: github.event_name == 'push' && github.ref == 'refs/heads/main' && env.LATEST_TAG != env.NEW_VERSION
       uses: ncipollo/release-action@v1
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
-        tag: ${{env.NEW_VERSION}}
+        tag: ${{ env.NEW_VERSION }}
         draft: false
-        body: ${{steps.build_changelog.outputs.changelog}}
+        body: |
+          [PyEPP on PyPI](https://pypi.org/project/pyepp/${{env.TRIMMED_VERSION}}/)
+
+          ${{ steps.build_changelog.outputs.changelog }}
         makeLatest: true
         artifacts: "./dist/*"
     - name: Cleanup workspace

README.md

@@ -9,7 +9,6 @@ any registry systems that support EPP and work with it. It supports bellow RFCs:
 - [RFC 5733 - Contact Mapping](https://datatracker.ietf.org/doc/html/rfc5733)
 - [RFC 5734 - Transport over TCP](https://datatracker.ietf.org/doc/html/rfc5734)
 
->This is an early version and not stable yet. Please use with care.
 
 ## Installation
 
@@ -128,6 +127,31 @@ Commands:
   run      Receive an XML file containing an EPP XML command and execute it.
 ```
 
+### Enable shell autocomplete
+To enable shell autocompletion for your shell follow the below commands:
+
+#### Zsh
+```sh
+mkdir -p ~/.pyepp
+_PYEPP_COMPLETE=zsh_source pyepp > ~/.pyepp/shell-complete.zsh
+```
+
+Source the file in `~/.zshrc`.
+```sh
+. ~/.pyepp/shell-complete.zsh
+```
+
+#### Bash
+```sh
+mkdir -p ~/.pyepp
+_PYEPP_COMPLETE=bash_source pyepp > ~/.pyepp/shell-complete.bash
+```
+
+Source the file in `~/.bashrc`.
+```sh
+. ~/.pyepp/shell-complete.bash
+```
+
 ## Development setup
 Clone this project. It's recommended to create virtual environment. Then install the dependencies and 
 development dependencies:

docs/cli.rst

@@ -72,6 +72,36 @@ And to get help for a specific command:
       --client-transaction-id TEXT
       -h, --help                    Show this message and exit.
 
+Enable shell autocomplete
+-------------------------
+To enable shell autocompletion for your shell follow the below commands:
+
+Zsh
+^^^^
+.. code-block:: text
+
+    mkdir -p ~/.pyepp
+    _PYEPP_COMPLETE=zsh_source pyepp > ~/.pyepp/shell-complete.zsh
+
+Source the file in ``~/.zshrc``.
+
+.. code-block:: text
+
+    . ~/.pyepp/shell-complete.zsh
+
+Bash
+^^^^
+.. code-block:: text
+
+    mkdir -p ~/.pyepp
+    _PYEPP_COMPLETE=bash_source pyepp > ~/.pyepp/shell-complete.bash
+
+Source the file in ``~/.bashrc``.
+
+.. code-block:: text
+
+    . ~/.pyepp/shell-complete.bash
+
 How to configure
 ----------------
 The epp server configuration and credentials can be passed to the cli in three different ways. It can be done either

docs/index.rst

@@ -11,8 +11,6 @@ It supports the bellow RFCs:
 * `RFC 5733 - Contact Mapping <https://datatracker.ietf.org/doc/html/rfc5733>`_
 * `RFC 5734 - Transport over TCP <https://datatracker.ietf.org/doc/html/rfc5734>`_
 
-.. note::
-   This is an early version and not stable yet. Please use with care.
 
 Installation
 ------------

docs/pyepp.rst

@@ -0,0 +1 @@
+:orphan:

docs/requirements.txt

@@ -1,3 +1,3 @@
 sphinx==6.2.1
-sphinx-rtd-theme==1.2.2
-myst-parser==2.0.0
+myst-parser==3.0.1
+sphinx-rtd-theme==2.0.0

pyepp/__init__.py

@@ -1,6 +1,7 @@
 """
 PyEPP Package
 """
-__version__ = "0.0.15"
+
+__version__ = "0.1.0"
 
 from pyepp.epp import EppCommunicator, EppResultCode, EppCommunicatorException

pyepp/cli/__main__.py

@@ -76,9 +76,9 @@ def pyepp_cli(ctx, server, port, client_cert, client_key, user, password, output
     ctx.obj = cli.PyEppCli(server, port, client_cert, client_key, user, password, output_format, no_pretty, dry_run)
 
     if verbose:
-        logging.basicConfig(level=logging.INFO)
+        logging.getLogger().setLevel(level=logging.INFO)
     if debug:
-        logging.basicConfig(level=logging.DEBUG)
+        logging.getLogger().setLevel(level=logging.DEBUG)
 
     utils.OUTPUT_FILE = file