Merge pull request #75 from codePerfectPlus/test

automating release process

Author: codeperfectplus

CHANGELOG.md

@@ -4,11 +4,16 @@ All notable changes to this project will be documented in this file. The format
 
 ## [Unreleased]
 
-## Proposed Changes/features
+## Upcoming
 
 - [x] Search book in the library
 - [x] Delete book from the library
-- [x] Cythonize the code   
+- [x] Cythonize the code  
+
+## [3.0.0] - 07-11-2022
+
+- [x] Added support for `--version` flag
+- [x] Added bash scripts for complete automation of the release process   
 
 ## [V2.0.4] -  01-11-2022
 

scripts/README.md

@@ -0,0 +1,10 @@
+# Scripts
+
+1. test_changes.sh - Test if the changes are valid and can be released. flake8/pytest are run and the version is checked.
+2. test_release.sh - Test the release on test.pypi.org.
+3. release.sh - Release the package to PyPI if both tests are successful.
+
+
+reference links:
+
+- https://packaging.python.org/en/latest/guides/using-testpypi/

scripts/release.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+check_command() {
+    if [ ! -x "$(command -v $1)" ]; then
+        echo "$1 is not installed"
+        pip install $1
+        exit 1
+    fi
+}
+
+check_directory() {
+    if [ ! -d "$1" ]; then
+        echo "$1 is not found"
+        exit 1
+    fi
+}
+
+check_file() {
+    if [ ! -f "$1" ]; then
+        echo "$1 is not found"
+        exit 1
+    fi
+}
+
+# check if the git is installed
+check_command git
+check_command flake8
+check_command twine
+check_file setup.py
+python3 setup.py sdist bdist_wheel
+check_directory dist
+python3 -m twine upload dist/*
+
+rm -rf dist
+rm -rf build
+rm -rf *.egg-info
+find . -name "*.pyc" -exec rm -rf {}\;

scripts/test_changes.sh

@@ -0,0 +1,27 @@
+#!/bin/sh
+
+# function to check the command exist or not
+check_command() {
+    if [ ! -x "$(command -v $1)" ]; then
+        echo "$1 is not installed"
+        pip install $1
+        exit 1
+    fi
+}
+
+# check if the git is installed
+check_command git
+check_command pytest
+check_command flake8
+
+flake8 . --isolated --exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox,**/migrations/** --ignore=E501,E402
+pytest
+
+# check the exit code of the last command
+if [ $? -eq 0 ]; then
+    echo "All tests passed"
+else
+    echo "Some tests failed"
+    exit 1
+fi
+

scripts/test_release.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+check_command() {
+    if [ ! -x "$(command -v $1)" ]; then
+        echo "$1 is not installed"
+        pip install $1
+        exit 1
+    fi
+}
+
+check_directory() {
+    if [ ! -d "$1" ]; then
+        echo "$1 is not found"
+        exit 1
+    fi
+}
+
+check_file() {
+    if [ ! -f "$1" ]; then
+        echo "$1 is not found"
+        exit 1
+    fi
+}
+
+# check if the git is installed
+check_command git
+check_command flake8
+check_command twine
+check_file setup.py
+python3 setup.py sdist bdist_wheel
+check_directory dist
+python3 -m twine upload --repository testpypi dist/*
+
+rm -rf dist
+rm -rf build
+rm -rf *.egg-info
+find . -name "*.pyc" -exec rm -rf {}\;

setup.py

@@ -3,14 +3,18 @@
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
+with open('requirements.txt') as f:
+    required = f.read().splitlines()
+
 setuptools.setup(
     name="audiobook",
-    version="2.0.4",
+    version="3.0.0",
     author="CodePerfectPlus",
     author_email="[email protected]",
     description="Listen to your favourite audiobook",
     long_description=long_description,
     long_description_content_type="text/markdown",
+    install_requires=required,
     url="https://github.com/codePerfectPlus/audiobook",
     keywords="audiobook",
     packages=setuptools.find_packages(),