UTMIST Python Package

Welcome to the UTMIST Python Package, a set of tools and utilities developed by the University of Toronto Machine Intelligence & Science Team (UTMIST) to support machine learning, data processing, and automation workflows.

Features

• Easy-to-use CLI commands for compute access and ML workflows
• Extensible design to integrate with your projects

Installation

You can install the package via pip:

pip install utmist

Or, to install from source, clone this repo and run:

pip install .

Usage

Importing in Python

import utmist

# Example usage
result = utmist.some_function()
print(result)

Command Line Interface

After installation, you can use the CLI tool:

utmist --help

Development

To contribute or develop locally:

1. Clone the repository:

   git clone https://github.com/yourorg/utmist.git
   cd utmist

2. Create a virtual environment and install dependencies:

   python3 -m venv venv
   source venv/bin/activate
   pip install -r requirements.txt
   pip install -e .

3. Run tests:

   pytest

Contributing

Test Package Locally

1. Clean your build environment

   rm -rf dist/ build/ *.egg-info
   

2. Build the package

   python3 -m build
   

   If you don't have the build package,

   pip install build
   

3. Install the package locally

   pip install dist/utmist-0.X.X-py3-none-any.whl //replace with correct version number
   

   or

   pip install .
   

   or for editable install

   pip install -e .
   

4. Upload to TestPyPi

   twine upload --repository-url https://test.pypi.org/legacy/ dist/*
   

   If you don't have twine ...

   pip install twine
   

We welcome contributions from members and the community! Please read our CONTRIBUTING.md for guidelines.

License

This project is licensed under the MIT License. See the LICENSE file for details.