pypackage_generator

---

Installation

All you need are the files new_pyproject.sh and envfile_template.

1. go to the source file
2. Save as...
3. Change permissions to make the file user executable

   chmod u+x new_pyproject.sh

4. go to the environment variable file
5. Save as...
   1. save the file in the same location as new_project.sh
6. Rename file to envfile

   mv envfile_template envfile

---

Quick Start Guide

Configure envfile

1. Open the envfile
   1. Enter your name in the author argument

      export AUTHOR="Timothy Helton"

   2. Enter your email address in the email argument

      export EMAIL="[email protected]"

Execution

The script has a single required argument, which is the name of the package.

./new_pyproject.sh example_package

A new repository will be generated in the current directory and initialized with Git version control.

Update the Docker Configuration

The base script creates the minimum number of objects to define Python and NGINX containers. This is done to allow the automation of initializing the Sphinx documentation. Once the script has been executed, modify the if __name__ = 'main': section of scripts/docker_config.py to add additional desired services. The following example would add a MongoDB container and configure the Python container to utilize a GPU.

if __name__ == '__main__':
    config = ComposeConfiguration()
    services = (
        ComposeService.MONGO,
    )
    for s in services:
        config.add_service(s)
    config.add_gpu()
    config.write()

Rebuild the Docker Environment

Once the scrips/docker_config.py file has been modified to the your liking call the following make target to update the Docker environment. This will:

• update the docker/docker-compose.yaml file
• rebuild the Docker environment

make docker-update-config

---

What will the script generate?

• Package Main Directory
  • Manifest File
  • Make File
  • Readme File
  • Data Directory
  • Docker Directory
    • Python Dockerfile
    • PyTorch Dockerfile
    • TensorFlow Dockerfile
    • Docker Compose File
  • Documentation Directory
  • Environment Variable File
  • Source Directory
    • Source Constructor
    • Tests Directory
      • Tests Constructor
      • Tests Fixture File
  • Git Ignore File
  • Notebook Directory
  • Requirements File
  • Package Configuration File
  • Package Constructor File
  • Scrips Directory
  • Wheel Directory

Makefile Targets

After the package is created there are a number of helpful shortcuts in the Makefile. The generated package README.md file has details for a number of the make targets.