create-project.sh

#!/bin/bash -e
#
# Description: Script to create a skeleton python project 
# Author:      M. H. Bani-Hashemian
# ==============================================================================

# Python interpreter path (e.g. conda)
#pyInterPATH=
topDIR=
projNAME=
pkgNAME=
# Enter the name of subpackages in the following list. 
# Example: subpkgLIST=('subpkg1' 'subpkg2')
declare -a subpkgLIST=()

mkdir -p ${topDIR}/${projNAME}
cd ${topDIR}/${projNAME}
touch README.md
touch requirements.txt
touch LICENSE
touch setup.py

# Create directories: 
# src                     main source directory
# src/pkgNAME             top level package 
# src/pkgNAME/subpkgNAME  subpackage
mkdir src tests docs data
mkdir src/${pkgNAME}
for subpkgNAME in ${subpkgLIST[@]};
do
	mkdir src/${pkgNAME}/${subpkgNAME}
done

# Add initialization files
touch src/${pkgNAME}/__init__.py
for subpkgNAME in ${subpkgLIST[@]};
do
	touch src/${pkgNAME}/${subpkgNAME}/__init__.py
done
touch tests/__init__.py
# Add python files
touch src/${pkgNAME}/${pkgNAME}.py
touch tests/test_${pkgNAME}.py
for subpkgNAME in ${subpkgLIST[@]};
do
	touch src/${pkgNAME}/${subpkgNAME}/${subpkgNAME}.py
	touch tests/test_${subpkgNAME}.py
done

# Activate virtual environment
python3 -m venv ${projNAME}-env
source ${projNAME}-env/bin/activate

# Dependencies : 
# here we grab dependencies using pipreqs
pip install pipreqs
pipreqs . --force  
pip install -r requirements.txt


# Generate a setup.py file 
# Enter the following: 
# version, license, your name (author) and email address (author_email), url (e.g. address to the github repo)
# edit metadata in classifiers or add additional data (complete list can be found at: https://pypi.org/pypi?%3Aaction=list_classifiers) 
# or add more arguments to setup()(complete list can be found at: https://setuptools.readthedocs.io/en/latest/references/keywords.html)
echo -e "
from setuptools import setup
from setuptools import find_packages

with open("README.md", "r") as fh:
    long_description = fh.read()
with open("requirements.txt", "r") as fh:
    requirements = [line.strip() for line in fh]

setup(
    name=${projNAME},
    version='0.0.0',
    license='MIT',
    author='M. H. Bani-Hashemian',
    author_email='hossein.banihashemian@alumni.ethz.ch',
    description='A script to create a python project from scratch.',
    long_description=long_description,
    long_description_content_type='text/markdown',
    url='https://github.com/seyedb/createPyProject',
    package_dir={'': 'src'},
    packages=find_packages('src'),
    test_suite='tests',
    classifiers=[
        'Development Status :: 1 - Alpha',
        'Intended Audience :: Developers',
        'Topic :: Software Development :: Build Tools',
        'Programming Language :: Python :: 3',
        'License :: OSI Approved :: MIT License',
        'Operating System :: OS Independent',
    ],
    keywords=[],
    python_requires='>=3.6',
    install_requires=requirements
)
" > setup.py