Metadata-Version: 2.1
Name: nbapy
Version: 1.0.6
Summary: Python client for NBA statistics located at nba.com
Home-page: https://github.com/jtpavlock/nbapy
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: pandas
Provides-Extra: dev
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: requests-cache ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'

# *nbapy - [stats.nba.com](https://stats.nba.com) API for python*

## Documentation
An ongoing process, but check out the [wiki](https://github.com/jtpavlock/nbapy/wiki) or feel free to poke around the codebase.

## Summary
A python facing API for stats.nba.com (Still in heavy development)

## Installation
NOTE: Developmental builds, are by no means stable If you want the stable version use:

```
$ pip install nbapy
```

Else:
- Download from source (git clone, zipped package)
- Run from the root directory:

```
$ pip install .
```

## Requirements
- [requests](http://www.python-requests.org/en/latest/)
- [pandas](https://pandas.pydata.org/)

## Planned development
### 1. Documentation
- All around documentation not only of nbapy but also stats.nba.com (it's pretty nonexistent)

## Development
#### 1. Fork the repository and create a feature/bug fix branch

#### 2. Install development requirements
`$ pip install -e . ".[dev]"`

#### 3. Hack away
#### 4. Create some tests

#### 5. Make sure it's good code
`$ pytest --cov`

`$ flake8`

#### 6. Submit a pull request

Other ways to contribute involve submitting any issues or adding some documentation!

## To-Do
- Jupyter Notebook documentation


