Metadata-Version: 2.1
Name: yc-central
Version: 0.0.1
Summary: My package description
Author-email: "<your name>" <some-email@gmail.com>
License: MIT
Keywords: one,two
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
Requires-Dist: yc-pypi[release,static-code-qa,test]; extra == "dev"
Provides-Extra: release
Requires-Dist: build; extra == "release"
Requires-Dist: twine; extra == "release"
Provides-Extra: static-code-qa
Requires-Dist: pre-commit; extra == "static-code-qa"
Requires-Dist: pylint; extra == "static-code-qa"
Requires-Dist: black; extra == "static-code-qa"
Requires-Dist: isort; extra == "static-code-qa"
Requires-Dist: flake8; extra == "static-code-qa"
Requires-Dist: flake8-docstrings; extra == "static-code-qa"
Requires-Dist: Flake8-pyproject; extra == "static-code-qa"
Requires-Dist: radon; extra == "static-code-qa"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"

# Yield Curve Central PyPi Package Distribution

Efficient, lightweight python package for interacting and analyzing the US Treasury Yield Curve through
data from AlphaVantage API web endpoints.

## Quick start

```bash
pip install yc-central
```

```python
from yc_central import ...
```

## Developing/Contributing

### System requirements

You will need the following installed on your machine to develop on this codebase

- `make` AKA `cmake`, e.g. `sudo apt-get update -y; sudo apt-get install cmake -y`
- Python 3.7+, ideally using `pyenv` to easily change between Python versions
- `git`

###

```bash
# clone the repo
git clone https://github.com/<your github username>/yc-pypi.git

# install the dev dependencies
make install

# run the tests
make test
```
