pydev

This repository contains a script that BVU students can run to build a Python development environment quickly. By running the command below (see Usage), the import script will accomplish the following:

1. Setup a virtual environment.
2. Install a Python toolset for linting, type-checking, and unit testing.
3. Create a Makefile to automatically run all of the tools in #2.
4. Create a setup.py file for packaging your software.

Usage

To install to your development directory, type the following.

curl -sS https://raw.githubusercontent.com/jbshep/pydev/main/import.sh | bash

Once installed, developers should enter the virtual environment by typing:

source env/bin/activate        # if using macOS or Linux
source env/Scripts/activate    # if using Windows

Code should be placed in the src directory. Tests go in the tests directory. Students should modify setup.py to specify the main function to be run when executing the package.

All verification checks and the package build can be run using the command:

make

Consult the Makefile for individual targets if you don't wish to run all checks and the build.

Installed Tools and Files/Directories

Tools currently installed by the import.sh script are:

• black
• mypy
• pylint
• pytest

The script will deposit the following files/directories into your current directory:

• a Makefile
• a setup.py file
• a pylint configuration file (.pylintrc)
• env: the virtual environment directory