python-flask-dev 0.0.6

A small example package

Python Flask Dev

Table of contents

1. Project description
2. Project setup
3. Contributing guidelines
4. Project documentation
5. Links to support resources
6. Terms of use

Project description

What kind of software is this?

Package containing modules with 'helper' functions to support the development of Python Flask applications.

---

Who can use this app?

Python Flask App Developer

---

Project overview

Language(s): Python

Framework(s): Python Flask Framework

Style guide(s): Python PEP 8

Project setup

Pre-requisites

Before using {Project name}, install necessary pkgs:

• PKG_NAME
• [...]

Requirements

GitHub will automatically not push any tokens.

However, to commit any changes the .gitignore file must include any files that contain credentials.

If the Markdown Changelog Generator is used, it needs to include 'changelog_generator.toml' because it lists your GitHub repo's PAT (Personal Access Token).

Install Python Flask Dev

1. {Write the step here.}

   {Explanatory text here}

   {Optional: Include a code sample or screenshot that helps your users complete this step}

2. {Write the step here.}

   a. {Substep 1}

   b. {Substep 2}

Configure Python Flask Dev

1. {Write the step here.}
2. {Write the step here.}

Run Python Flask Dev

1. {Write the step here.}
2. {Write the step here.}

Troubleshoot Python Flask Dev

1. {Write the step here.}
2. {Write the step here.}

Issue	Solution
{Describe the issue here}	{Write solution here}
{Describe the issue here}	{Write solution here}
{Describe the issue here}	{Write solution here}

Other troubleshooting support:

• {Link to FAQs}
• {Link to runbooks}
• {Link to other relevant support information}

Recommendations

• When working through a smaller project such as a program or a software application, a Changelog is recommended.

Changelog entries typically follow a basic format that includes information about the code that was added to enhance a project, removed for any purpose, and modified to resolve errors.

Changelog entries are entered in the CHANGELOG file once code is committed to the main branch:

[VERSION #] - [TIMESTAMP]

[ADDED || REMOVED || FIXED]

<DESCRIPTION>

---

Version Control Process

I. Create a Feature Branch Any code updates for a version change -- [Major].[Minor].[Patch] -- should be on a separate branch, referred to as a 'feature' branch.

Once work on the branch is completed, a pull-request can be created to merge the branch into dev, a staging/pre-release branch, where those changes are tested.

Once the staging branch is tested, stable code can be merged into main a production/release branch.

---

Maintaining repos

Branch Naming Conventions

<VERSION-RELEASE-#>/<FEATURE_NAME>/<CONTRIBUTOR>

• <VERSION-RELEASE-#>: Refer to SemVer for details

• <FEATURE_NAME>: Descriptive title for the feature

• <CONTRIBUTOR>: GitHub account name, e.g., https://github.com/

IV. Documenting changes

Maintaining a CHANGELOG file is always recommended for a quick overview of how the project is progressing.

1. Checkout main locally.
2. From a terminal session, run the commands to use the GitHub ChangeLog Generator.
3. Commit the CHANGELOG file to the remote branch.

changelog-generator-md

Project documentation

Standard project docs are located in the {PROJECT_ROOT} folder.

• README
• LICENSE
• CHANGELOG
  • Refer to the Project dependencies section of the README for more information on generating a CHANGELOG file

Links

• : <LINK_DESC>
• [...]

Terms of use

Python Flask Dev is licensed under MIT