utils4 Library Documentation
Overview
The utils4
library is a CPython and C project which contains
generalised, utility-based functions, designed to be an underlying
libary across your various Python 3.7+ projects.
utils4
is a complete overhaul of the utils3
code base, which now
features a streamlined code base, complete documentation and a full test
suite as part of the source distribution.
Note
Some out-of-date modules and methods have been removed from
utils4
. If you find a method is missing, please continue to use
the latest release of utils3
(v0.15.1) for this functionality.
If you have any questions that are not covered by this documentation, or if you spot any bugs, issues or have any recommendations, please feel free to contact us.
Using the Library
This documentation suite contains detailed explanation and example usage for each of the library’s importable modules. For detailed documentation, usage examples and links the source code itself, please refer to the Libary API Documentation page.
If there is a specific module or method which you cannot find, a search field is built into the navigation bar to the left.
Installation
The easiest way to install utils4
is using pip
after activating
your virtual environment:
pip install utils4
Building a Wheel File
Important
If using a virtual environment, be sure to activate the environment first.
As the library contains some C components, building on Windows may prove tricky. To help address this, we’ve pre-compiled some of the more popular wheels for you. These wheels are available in GitHub Releases.
If a wheel is not available for your architecture, a wheel can be built from source, if the appropriate C build tools are installed on your system.
Download the latest source distribution from PyPI.
Unpack the archive and navigate into the new unpacked directory.
Run the following command from the terminal, after activating the appropriate virtual environment:
python -m build . --wheel --no-isolation
This will build a wheel and place it in the local dist
directory for
installation.
List of available wheel files
We will create some wheel files, with each release, for the platforms and architectures listed below, which can be downloaded from GitHub Releases. If we’ve just released and you don’t see a wheel file there, please check back the following day as we may still be working through the builds. However, if you require something different than what we provide, the source distributions can also be downloaded from PyPI.
Linux armv7 |
Linux aarch64 |
Linux x86_64 |
Windows x86_64 |
|
---|---|---|---|---|
Python 3.7 |
Y |
Y |
Y |
Y |
Python 3.8 |
Y |
Y |
Y |
Y |
Python 3.9 |
Y |
Y |
Y |
Y |
Python 3.10 |
Y |
Y |
Y |
Y |
Python 3.11 |
Y |
Y |
Y |
Y |
Python 3.12 |
Y |
Y |
Y |
Y |
Questions or Issues
If you have any issues or questions with your installation, please refer to the Troubleshooting section, or feel free to contact us.
Troubleshooting
No guidance at this time.
Documentation Contents
Indices and Tables
Footnotes
Last updated: 13 Nov 2024