Metadata-Version: 2.1
Name: myb-coinbase-pro-api
Version: 1.0.0
Summary: Python library for communicating with the Coinbase Pro API
Home-page: https://github.com/mine-your-business/myb-coinbase-pro-api
Author: Mine Your Business
Author-email: mine.your.business.crypto@gmail.com
License: GPL-3
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: requests (>=2.22.0)

# myb-coinbase-pro-api
 An API client for the Coinbase Pro API

## Installation

The package is availble via PyPi and can be installed with the following command:
```
pip3 install myb-coinbase-pro-api
```

To install it from the repo, clone the repo and cd into the directory:

```
git clone https://github.com/mine-your-business/myb-coinbase-pro-api.git
cd myb-coinbase-pro-api
```

You can install this library with `pip`:

```
pip3 install .
```

## Testing

This project makes use of the [Coinbase Pro "Sandbox" API](https://docs.pro.coinbase.com/#sandbox) for tests

Before tests can be run, a `local_env_vars.py` file needs to be created in the [`tests`](tests) folder. You can use the [`local_env_vars_example.py`](tests/local_env_vars_example.py) file as an example for the content - just be sure to fill out the API Key data with actual secrets for API keys created on the Coinbase Pro Sandbox site.

To run tests, simply run the following command:

```
pytest --verbose
```

## Releases

Releases should follow a [Semantic Versioning](https://semver.org/) scheme. 

When changes have been made that warrant a new release that should be published, modify the `__version__` in [`setup.py`](setup.py) 

After the change is merged to the `main` branch, go to [releases](https://github.com/mine-your-business/myb-coinbase-pro-api/releases) and `Draft a new release`. The `Tag version` should follow the pattern `v1.0.0` and should `Target` the `main` branch. 

The `Release title` should not include the `v` from the tag and should have a reasonably detailed description of the new release's changes. 

Once the release has been published, the [`.github/workflows/python-publish.yml`](.github/workflows/python-publish.yml) GitHub Actions Workflow should trigger and automatically upload the new version to [PyPi](https://pypi.org/) using GitHub secrets credentials stored with the [Mine Your Business GitHub Organization](https://github.com/mine-your-business).


