FHPythonUtils/CheckRequirements

========================= No Longer Supported =========================

This project has reached the end of development and is no longer supported

• The repository, including issues, pull requests, labels, milestones, projects, wiki, releases, commits, tags, branches, reactions, and comments, has transitioned into a read-only state.
• While active contributions and changes are no longer accepted, you can still fork and clone the repository. The project's original license remains in effect.

• The repository is scheduled for permanent deletion on 31/01/2025. We encourage you to download any materials or resources you may need from the repository before this date.
• While this project is unlikely to be un-archived, the possibility remains open, albeit with minimal probability.

poetry show --latest

or

poetry show --outdated

========================= No Longer Supported =========================

Note: checkrequirements is deprecated in favour of poetry show --latest or poetry show --outdated

poetry show --latest

Uses poetry to check outdated dependencies and set a status code to 1 if outdated packages are found. This is ideal for ci/cd. If running manually, its better to use poetry directly.

Note: this only supports poetry based environments. requirements.txt and other build systems are not currently supported!

• What Does This Mean Now?
• What Does This Mean for the Future?
• What to use instead?
• 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
• Testing
• Download Project
  • Clone
    • Using The Command Line
    • Using Desktop
  • Download Zip File
• Community Files
  • Licence
  • Changelog
  • Code of Conduct
  • Contributing
  • Security
  • Support
  • Rationale

pip install checkrequirements

Head to https://pypi.org/project/checkrequirements/ 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 [email protected]

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://.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

For testing with the version of python used by poetry use

poetry run pytest

Alternatively use tox to run tests over python 3.8 - 3.11

tox

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://.com/FHPythonUtils/CheckRequirements

More information can be found at https://help..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..com/en/desktop/contributing-to-projects/cloning-a-repository-from--to--desktop

1. Download this 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.