Metadata-Version: 2.1
Name: sandspythonfunctions
Version: 0.0.1a11
Summary: Functions I use regularly with my python projects
Home-page: https://github.com/ldsands/SandsPythonFunctions
License: MIT
Author: ldsands
Author-email: ldsands@outlook.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: altair (>=4.1.0,<5.0.0)
Requires-Dist: altair_saver (>=0.5.0,<0.6.0)
Requires-Dist: gensim (>=3.8.3,<4.0.0)
Requires-Dist: matplotlib (>=3.2.1,<4.0.0)
Requires-Dist: nltk (>=3.5,<4.0)
Requires-Dist: notebook (>=6.0.3,<7.0.0)
Requires-Dist: numpy (>=1.18.5,<2.0.0)
Requires-Dist: pandas (>=1.0.3,<2.0.0)
Requires-Dist: pyarrow (>=0.16.0,<0.17.0)
Requires-Dist: pyemd (>=0.5.1,<0.6.0)
Requires-Dist: wmd (>=1.3.2,<2.0.0)
Requires-Dist: zstandard (>=0.13.0,<0.14.0)
Project-URL: Repository, https://github.com/ldsands/SandsPythonFunctions
Description-Content-Type: text/markdown

# Sands Python Functions

Some functions I find useful regularly and I put them all into one package for easy access

I created this using [Poetry](https://python-poetry.org/).

## Instructions

- To build this you must first install poetry see instructions [here](https://python-poetry.org/docs/#installation)
- However to make it easy to access this is all of the code you'll need on linux to make this run (note that I use zsh not bash for my shell)
    - First you must navigate to the folder containing these files `CHANGELOG.md   LICENSE  'README reference.md'   README.md   dist   poetry.lock   pyproject.toml   src`
    - You then to make sure that you have the python environment that you want activated
    - You can then enter the code below

```sh
poetry build
poetry install
```

## Basic Usage Example

TODO:

## Included Packages

### Functions from EmailFunctions

- 

### Functions from MultiprocessingFunctions

- 

### Functions from ParquetFunctions

- 

### Functions from PrintFunctions

- 

### Functions from TimerFunctions

- 

## Testing

Pytest runs in whatever directory you're located in at the time you run pytest so if you're not in the directory of the test scripts pytest will not see the files it needs to and will then fail.

Follow the code below to test the functions

```sh
cd src/tests
pytest /src/tests/EmailFunctions_test.py
pytest /src/tests/MultiprocessingFunctions_test.py
pytest /src/tests/ParquetFunctions_test.py
```

## CI/CD

See [this repo](https://github.com/speg03/shishakai/blob/971261e6f73ee8b9dcc83837b6c1a5f809c985f8/.github/workflows/upload-python-package.yml) for an example of someone using poetry with they're python project to upload to PyPI on push to master.

