Metadata-Version: 2.4
Name: ubiquerg
Version: 0.9.2
Summary: Various utility functions
Project-URL: Homepage, https://github.com/pepkit/ubiquerg/
Author: Vince Reuter
License-Expression: BSD-2-Clause
License-File: LICENSE.txt
Keywords: tools,utilities,utility
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.10
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Description-Content-Type: text/markdown

# ubiquerg

![Run pytests](https://github.com/pepkit/ubiquerg/workflows/Run%20pytests/badge.svg)

Ubiquerg is a utility package with a collection of universally helpful functions. The name means work (erg) everywhere (ubique), indicating our intention for these to be low-level functions that can be used in lots of different places. Functions are divided into groups, including:

- collection
- environment
- files
- paths
- system
- web
- cli_tools

## Development guidelines

- Ubiquerg should have no dependencies outside of standard built-in python modules. Please do not add any functions that introduce a new dependency.
- Functions should be generic. They should perform basic, low-level processing that is not specific to a particular application.
- Functions should only be added to ubiquerg if they are used in at least 2 existing modules.
- Functions should be kept relatively small and simple (ideally <50 lines of code).
