semvec/pypi-packages huggingface dataset:
m-gen-utils 0.11
A collection of utilities for Metis
License: MIT

# m_utils
- Version 0.8.0
- 12/31/2022

### Description
- This is a collection of utilities that are used in the Metis project and can be used in other projects.

### Installation
- There is a tar file in the dist directory of the project.  You can install the tar file using the following command:
  - `pip install m_utils-0.8.0.tar.gz`

### Usage
- Import the utilities you want to use into your project.  

### Testing
- To run tests for the metis_utils project:
  - Make a copy of the example.env file in the root directory of the project.  Rename the copy to ".env".
  - Update the environment variables in the .env file with the appropriate values.
  - Make a copy of the example_storage.ini and example_pgdb.ini files in the config_utils directory.  Rename the copies to "storage.ini" and "pgdb.ini".
  - Update the environment variables in the storage.ini and pgdb.ini files with the appropriate values. (storage.ini is being replaced by the .env file)
  - Create a virtual environment for the metis_utils project.
  - Activate the virtual environment.
  - Ensure the "pytest" library is installed.
  - Run the "pytest ." command from the root directory of the project.

### Dependencies
- Install the requirements.txt file in the root directory of the project.

### To Do
- Create a directory for the pulse utils module (utils.py) and move the pulse utils module into the directory.
- Write tests for the pulse utils module.
- Create pip package for the metis_utils project.
- If possible create a pip package for the submodules of the metis_utils project so that they can be installed individually.

### Contributing
- If you would like to contribute to the metis_utils project, please write tests for the code you are contributing and submit a pull request.