Metadata-Version: 2.1
Name: threemystic-common
Version: 0.1.15
Summary: Common Library for for various tool sets
Project-URL: Homepage, https://github.com/3MysticApes/3mystic_common
Project-URL: Bug Tracker, https://github.com/3MysticApes/3mystic_common/issues
Author: Ron Truex
License-Expression: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.8
Requires-Dist: asyncio>=3.4.3
Requires-Dist: colorama; platform_system == 'Windows'
Requires-Dist: cryptography>=38.0.3
Requires-Dist: currencyconverter>=0.17
Requires-Dist: openpyxl>=3.0.9
Requires-Dist: pathvalidate>=3.0.0
Requires-Dist: pycryptodomex>=3.14.1
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: requests>=2.27.1
Requires-Dist: ruamel-yaml>=0.17.31
Requires-Dist: typing-extensions>=4.4.0
Description-Content-Type: text/markdown

# 3mystic_common
A set of common files that are used for the various projects under 3 Mystic Apes

This project is currently in beta, along with the other projects. Once the other projects come out of beta this one will as well. However, this is also, the most stable of the project. I am trying not to change things that would break from version to version. So if you would like to use something here, it should be relatively safe. I will try to call out breaking changes.

# Install

## pip

The latest version of this project is currently being pushed to
https://pypi.org/project/threemystic-common/

pip install threemystic-common

If you would prefer to install directly from GitHub you need to install Hatch.
Please refer to the section below for that.

Once hatch is installed you can use pip

pip install https://github.com/3MysticApes/3mystic_common



## Hatch
This project is packaged using Hatch. If you need to install Hatch please refer to their documentation
https://hatch.pypa.io/latest/install/

# Contribute
You need to install Hatch. Please see the previous Hatch section under install.

Once you download the project you can do the following
You should be able to run the following command in the root directory for a general status
hatch status

Then from the root directory you can run
pip install ./

I would suggest while you are debugging issues to install it with the command below. Once you are done with your development you can uninstall. This allows you to make edits and test easier.
pip install -e ./
https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-e