README.md

    _       _   _ _     
   (_)_   _| |_(_) |___ 
   | | | | | __| | / __|
   | | |_| | |_| | \__ \
  _/ |\__,_|\__|_|_|___/
 |__/                                                     

---

Overview

jutils is a simple Python 3.10+ package which gives the user various tools. These tools are broken down into sub-modules in which the user can import individually.

Table of contents

• Overview
• Table of contents
• Install & use
  • Test
• Objectives
• Credits
• Licence
• Links

Install & use

1. From terminal: pip install jutl
2. From python environment: from jutl import <submodule> where <submodule> is one from the following:

• averages
• calculators
• converters
• cryptography
• datastructures
• ecxeptions
• formatting
• language
• logic
• pipelining
• sorters
• timers
• utilities

Test

1. Clone repository: git clone https://github.com/JordanWelsman/jutils.git
2. Build module for testing: python3 setup.py bdist_wheel
3. Install module locally: pip install jutl -e .
4. Run tests with PyTest: pytest test/<submodule> where <submodule> is one from the above list.

Objectives

• Publish a package of tools I have developed that I use in production applications.
• Help other users improve their workflows and contribute to more performant applications.

Credits

jutils was created, developed, and is currently maintained by Jordan Welsman.

Licence

jutils is developed and distributed under the MIT license.

Note See LICENSE for more details.

Links

📁 See this project on GitHub

🎁 See this project on PyPI

🐱 Follow me on GitHub

💼 Connect with me on Linkedin

📧 Send me an email