FredHappyface Makefile for python. Run one of the following subcommands

install: Poetry install
build: Build documentation, requirements.txt, and run poetry build
publish: Run poetry publish (interactive)
audit: dependency checking, security analysis and complexity/ Maintainability
checking. Use with --fast to speed up the security analysis.

• Example Output
• Documentation
• Install With PIP
• Language information
  • Built for
• Install Python on Windows
  • Chocolatey
  • Windows - Python.org
• Install Python on Linux
  • Apt
  • Dnf
• Install Python on MacOS
  • Homebrew
  • MacOS - Python.org
• How to run
  • Windows
  • Linux/ MacOS
• Building
• Download Project
  • Clone
    • Using The Command Line
    • Using GitHub Desktop
  • Download Zip File
• Community Files
  • Licence
  • Changelog
  • Code of Conduct
  • Contributing
  • Security
  • Support
  • Rationale

fhmake install

fhmake build

fhmake publish

fhmake audit

A high-level overview of how the documentation is organized organized will help you know where to look for certain things:

• The Technical Reference documents APIs and other aspects of the machinery. This documentation describes how to use the classes and functions at a lower level and assume that you have a good high-level understanding of the software.

"Slim" Build: Install simplesecurity[full], poetry, checkrequirements[full] and licensecheck[full] with pipx

pip install fhmake

Otherwise:

pip install fhmake[full]

Head to https://pypi.org/project/fhmake/ for more info

This program has been written for Python versions 3.8 - 3.11 and has been tested with both 3.8 and 3.11

choco install python

To install Python, go to https://www.python.org/downloads/windows/ and download the latest version.

sudo apt install python3.x

sudo dnf install python3.x

brew install python@3.x

To install Python, go to https://www.python.org/downloads/macos/ and download the latest version.

• Module py -3.x -m [module] or [module] (if module installs a script)

• File py -3.x [file] or ./[file]

• Module python3.x -m [module] or [module] (if module installs a script)

• File python3.x [file] or ./[file]

This project uses https://github.com/FHPythonUtils/FHMake to automate most of the building. This command generates the documentation, updates the requirements.txt and builds the library artefacts

Note the functionality provided by fhmake can be approximated by the following

handsdown  --cleanup -o documentation/reference
poetry export -f requirements.txt --output requirements.txt
poetry export -f requirements.txt --with dev --output requirements_optional.txt
poetry build

fhmake audit can be run to perform additional checks

1. Press the Clone or download button in the top right
2. Copy the URL (link)
3. Open the command line and change directory to where you wish to clone to
4. Type 'git clone' followed by URL in step 2

   git clone https://github.com/FHPythonUtils/FHMake

More information can be found at https://help.github.com/en/articles/cloning-a-repository

1. Press the Clone or download button in the top right
2. Click open in desktop
3. Choose the path for where you want and click Clone

More information can be found at https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop

1. Download this GitHub repository
2. Extract the zip archive
3. Copy/ move to the desired location

MIT License Copyright (c) FredHappyface (See the LICENSE for more information.)

See the Changelog for more information.

Online communities include people from many backgrounds. The Project contributors are committed to providing a friendly, safe and welcoming environment for all. Please see the Code of Conduct for more information.

Contributions are welcome, please see the Contributing Guidelines for more information.

Thank you for improving the security of the project, please see the Security Policy for more information.

Thank you for using this project, I hope it is of use to you. Please be aware that those involved with the project often do so for fun along with other commitments (such as work, family, etc). Please see the Support Policy for more information.

The rationale acts as a guide to various processes regarding projects such as the versioning scheme and the programming styles used. Please see the Rationale for more information.