README

Python Guide for Practicing Wizards

Documentation

https://shawnjburke.github.io/py_guide/

https://py-guide.readthedocs.io/en/latest/

The docs are hosted with gitHub Pages, with html in the docs/ folder, powered by reStructured text markup in the data_source folder. You can get to the root at py_quide. They are also mirrored on Read the Docs.

Purpose of this Project

This project implements a Python Project generator. It’s aim is to create a standard framework for Python projects that includes best practices. The results should be code that is documented, has an installation and versioning paradigm in place, and makes it easier for a programmer to do things that are often tedious.

Best practice steps are organized as follows:

  1. Install Python and Install PyCharm
  2. Install sjb.pyguide
  3. Generate project

Installation

This application can be installed via pip.

c:\\Python37>scripts\pip install sjb.pyguide
Successfully installed Menu-3.1.0 configparser2-4.0.0 sjb.pyguide-0.2.5
c:\Python37>scripts\py_guide --show_menu

Version History

  • 0.2.5 - Fix missing installation requirements in setup.py such as missing package_data items. Console invoked generator appears functional.
  • 0.2.4 - Fix issues with generated project, wheel installation file, not working. Add several files missing from generated project.
  • 0.2.3 - Beta version of project generator. Creates a Python 3.x project with best practices, including initialized virtual environment.
  • 0.2.2 - Adding in incomplete changes for project generator on way to v0.3.0. Will create directory structure and 1/2 dozen files for the project. Not complete yet.
  • 0.2.1 - Remove revealjs theme which is no longer supported and didn’t work right anyway.
  • 0.2.0 - Updated a number of package requirements such as sphinx themes to meet compatibility requirements.
  • 0.1.0 - First version with semantic versioning schema. Most of documentation is strong. Console script to create a project is in an development state.