Metadata-Version: 2.1
Name: podlozhnyy-module
Version: 2.6.1
Summary: One place for the most useful methods for work
Home-page: https://github.com/NPodlozhniy/podlozhnyy-module
Author: Nikita Podlozhnyy
Author-email: podlozhnyy.ne@phystech.edu
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
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 :: 3.12
Requires-Python: >=3.7.0
Description-Content-Type: text/markdown
Requires-Dist: scikit-learn (>=0.24.2)
Requires-Dist: statsmodels (>=0.12.2)
Requires-Dist: numpy (>=1.20.3)
Requires-Dist: pandas (>=1.2.4)
Requires-Dist: seaborn (>=0.11.1)
Requires-Dist: holoviews (>=1.14.3)
Requires-Dist: matplotlib (>=3.4.2)
Requires-Dist: scipy (>=1.6.3)
Requires-Dist: nltk (>=3.6.2)
Requires-Dist: rpy2 (>=3.4.2)

# podlozhnyy-module

A set of tools to simplify data analysis in particular:
 - risk analytics package
 - statistical utils for AB testing, analysis of correlations and variance
 - bootstrap method and permutations criteria for non-parametric testing
 - time series analysis and forecasting
 - classical machine learning

### Getting started

Easy installation via `pip`

```
$ pip install podlozhnyy-module
```

### For developers

If you would like to contribute to the project yo can do the following

1. Create a new virtual environment and activate it (_for Windows use: `my_env\Scripts\activate` instead of the last command_)
```
$ python -m venv my_env
$ source my_env/bin/activate
```

2. Copy the repo
```
$ git clone https://github.com/NPodlozhniy/podlozhnyy-module.git
```

3. Install requirement dependecies for developers
```
$ pip install -r requirements_dev.txt
```

4. Make changes and then release version to PyPI (use `--repository-url` argument to upload code to test PyPI version)
```
$ python setup.py sdist bdist_wheel
$ twine upload --repository-url https://test.pypi.org/legacy/ dist/*
```

:heavy_exclamation_mark: Important Update :heavy_exclamation_mark: since 2024 PyPi doesn't allow to push without API token, so you need to [create](https://pypi.org/help/#apitoken) one and then push using either `.pypirc` file, what actually doesn't work for me, or specifying credentials during the call

```
$ twine upload --repository-url https://test.pypi.org/legacy/ dist/* -u __token__ -p <YOUR TOKEN>
```

5. To test the package create another virtual environment and then install library from PyPI using the following command
```
$ pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple podlozhnyy-module
```


