Skip to content

Commit b1bd01f

Browse files
committed
Update setup and README for pypi
1 parent 0d19ed8 commit b1bd01f

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@ For questions about API usage, the [Octane.gg discord](https://t.co/aikJXkBPQG?a
1414

1515
## Installation
1616

17+
Simply install the package via pip:
18+
1719
```bash
18-
git clone https://github.com/amas0/octanegg.git
19-
pip install ./octanegg
20+
pip install octanegg
2021
```
2122

2223
## Example usage
@@ -109,4 +110,4 @@ The 6 most seen players were:
109110
In this pull we see the rosters of Rogue and NRG played the most S-tier games in the first half of 2021.
110111

111112
These two examples are relatively simple data pulls and there is much more one can do with the API. The best way to
112-
explore it is to dig in and use it.
113+
explore it is to dig in and use it.

setup.py

+8
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
1+
from pathlib import Path
12
from setuptools import setup, find_packages
23

4+
readme_path = Path(__file__).parent / 'README.md'
5+
6+
with open(readme_path, 'r', encoding='utf-8') as f:
7+
long_description = f.read()
8+
39
setup(name='octanegg',
410
version='1.0',
511
author='amas0',
612
author_email='andrew.mascioli1@gmail.com',
713
description='Python client library for octane.gg public API',
14+
long_description=long_description,
15+
long_description_content_type='text/markdown',
816
url='https://github.com/amas0/octanegg',
917
packages=find_packages(),
1018
install_requires=[

0 commit comments

Comments
 (0)