Skip to content

Commit e6d12ef

Browse files
committed
Fix install docs for GitHub release
1 parent da4d4d4 commit e6d12ef

2 files changed

Lines changed: 67 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ This package is built around the workflows normal users can actually use. It doe
1111

1212
## Install
1313

14+
Install from GitHub:
15+
1416
```bash
15-
pip install SteamCommunityKit
17+
pip install git+https://github.com/ja7den2006/SteamCommunityKit.git
1618
```
1719

18-
For local development:
20+
Install from a local checkout:
1921

2022
```bash
2123
pip install -e .[dev]
@@ -162,6 +164,7 @@ print(snapshot["listing_summary"]["listing_count"])
162164

163165
## Documentation
164166

167+
- [Installation Guide](docs/installation.md)
165168
- [Authentication Guide](docs/authentication.md)
166169
- [Community Guide](docs/community.md)
167170
- [Groups Guide](docs/groups.md)
@@ -202,4 +205,3 @@ python examples/smoke_test.py --username YOUR_USERNAME --password YOUR_PASSWORD
202205
## Disclaimer
203206

204207
This project is not affiliated with Valve or Steam. Steam pages and response shapes can change over time, so some community-backed helpers may need maintenance if Steam updates its HTML or request flows.
205-

docs/installation.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Installation
2+
3+
## Install From GitHub
4+
5+
SteamCommunityKit is currently intended to be installed directly from the repository:
6+
7+
```bash
8+
pip install git+https://github.com/ja7den2006/SteamCommunityKit.git
9+
```
10+
11+
Install a specific branch or commit if needed:
12+
13+
```bash
14+
pip install git+https://github.com/ja7den2006/SteamCommunityKit.git@main
15+
```
16+
17+
## Install From A Local Checkout
18+
19+
```bash
20+
git clone https://github.com/ja7den2006/SteamCommunityKit.git
21+
cd SteamCommunityKit
22+
pip install -e .[dev]
23+
```
24+
25+
## Build Artifacts
26+
27+
To build a wheel and source distribution locally:
28+
29+
```bash
30+
python -m build
31+
```
32+
33+
This produces:
34+
35+
- `dist/steamcommunitykit-<version>.tar.gz`
36+
- `dist/steamcommunitykit-<version>-py3-none-any.whl`
37+
38+
## Python Version
39+
40+
SteamCommunityKit currently targets Python `3.8+`.
41+
42+
## Dependencies
43+
44+
Runtime dependencies:
45+
46+
- `requests`
47+
- `rsa`
48+
- `PyJWT`
49+
50+
Development extras currently include:
51+
52+
- `pytest`
53+
- `build`
54+
55+
## Sanity Check
56+
57+
After install:
58+
59+
```bash
60+
python -c "from steamcommunitykit import SteamClient; print(SteamClient)"
61+
```
62+

0 commit comments

Comments
 (0)