Metadata-Version: 2.1
Name: hxm-refuel
Version: 0.1.6
Summary: Wrapper for financial database APIs
Author: djmcnay
Author-email: 39102979+djmcnay@users.noreply.github.com
Requires-Python: >=3.10,<3.11
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: cryptography (>=41.0.5,<42.0.0)
Requires-Dist: pyarrow (>=10.0.1,<10.1.0)
Requires-Dist: pytest (>=7.4.2,<8.0.0)
Requires-Dist: snowflake-connector-python (>=3.2.0,<4.0.0)
Requires-Dist: snowflake-sqlalchemy (>=1.5.0,<2.0.0)
Requires-Dist: xbbg (>=0.7.7,<0.8.0)
Description-Content-Type: text/markdown

# HongXiongMao Refuel

Toolbox for importing data from various financial sources; 
for a personal project so if you are here by accident I highly advise you look elsewhere.

## Installation 

### Bloomberg API
To make Bloomberg calls, the `blpapi` package must be installed; we then extend the excellent `xbbg` package. 
Unfortunately, installing of `blpapi` can be a pain in the backside.
I can't get `pyproject.toml` to correctly install `blpapi` as a dependency.

Using pip instruction from [the Bloomberg website](https://www.bloomberg.com/professional/support/api-library/)

```
python -m pip install --index-url=https://bcms.bloomberg.com/pip/simple blpapi
```

Poetry [requires 2 steps](https://github.com/python-poetry/poetry/issues/7587)
1. Set up Bloomberg as a source,
2. installing `blpapi`

```
poetry source add --priority=supplemental bloomberg https://bcms.bloomberg.com/pip/simple/
poetry add --source bloomberg blpapi
```

### Snowflake SQL
In order to get snowflake connectors working we've had to install several additional packages. 
Snowflake is very picky about which versions of pyarrow etc... are installed and requires old versions.
```
snowflake-connector-python = "^3.2.0"
snowflake-sqlalchemy = "^1.5.0"
pyarrow = ">=10.0.1, <10.1.0"
cryptography = "^41.0.5"
```

## Publishing to PyPi
I'm no pro at deploying packages to PyPi, so these are my notes for deployment of a poetry package. 
For reference, I followed 
[this tutorial](https://www.digitalocean.com/community/tutorials/how-to-publish-python-packages-to-pypi-using-poetry-on-ubuntu-22-04)

Key points:
* (PyPi account is required)[https://pypi.org/manage/account/#account-emails]
* (Configure Poetry)[https://python-poetry.org/docs/repositories/#configuring-credentials]
* poetry build
* poetry publish

```
# configure API key
poetry config pypi-token.pypi <pypi-reallyREALLYllongKEY...>

# The build bit
(base) (hxm-refuel-py3.10) PS C:\Users\XXX\Documents\GitHub\hxm-refuel> poetry build

Building hxm-refuel (0.1.0)
  - Building sdist
  - Built hxm_refuel-0.1.0.tar.gz
  - Building wheel
  - Built hxm_refuel-0.1.0-py3-none-any.whl

# publishing bit
(base) (hxm-refuel-py3.10) PS C:\Users\T333208\Documents\GitHub\hxm-refuel> poetry publish

Publishing hxm-refuel (0.1.0) to PyPI
 - Uploading hxm_refuel-0.1.0-py3-none-any.whl 0%
 - Uploading hxm_refuel-0.1.0-py3-none-any.whl 85%
 - Uploading hxm_refuel-0.1.0-py3-none-any.whl 100%
 - Uploading hxm_refuel-0.1.0.tar.gz 0%
 - Uploading hxm_refuel-0.1.0.tar.gz 100%
```

