You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-11Lines changed: 13 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,8 +21,7 @@ for developers who want something that 'just works'.
21
21
22
22
We support getting information on all games,
23
23
addons, categories, files, and so much more!
24
-
We also offer easy to use methods for downloading
25
-
files.
24
+
We also offer easy to use methods for downloading files.
26
25
27
26
# Example
28
27
@@ -33,7 +32,7 @@ GAME_ID = 432 # ID of the game you want to fetch, in this case Minecraft
33
32
34
33
# Create the CurseClient:
35
34
36
-
curse = CurseClient()
35
+
curse = CurseClient(API_KEY)
37
36
38
37
# Get the game info:
39
38
@@ -58,15 +57,16 @@ from cursepy import CurseClient
58
57
59
58
# Create the client:
60
59
61
-
client = CurseClient()
60
+
client = CurseClient(API_KEY)
62
61
63
62
# Get a tuple of all games:
64
63
65
64
games = client.games()
66
65
```
67
66
68
67
The CurseClient offers simple to use navigational methods for obtaining necessary information from CurseForge.
69
-
CurseClient also allows for callbacks to be bound to events,
68
+
Because CurseClient utilizes the official CurseForge API, we require an [API key](https://docs.curseforge.com/#what-is-curseforge-core) to use.
69
+
CurseClient also allows for callbacks to be bound to events,
70
70
meaning when an event is fired,
71
71
your custom callback will also be cued.
72
72
Here is an example of this in action:
@@ -122,7 +122,7 @@ mixed around, allowing for automated and easier customization
122
122
compared to sub-classing.
123
123
124
124
cursepy has extensive documentation on handler development,
125
-
which contains best practice recommendations. Docs on the cusepy Handler Framework(CHF)/tutorials on how to use the development handlers are already built into cursepy.
125
+
which contains best practice recommendations. Docs on the cursepy Handler Framework(CHF)/tutorials on how to use the development handlers are already built into cursepy.
126
126
Have a look at the [Handler Development Tutorial](https://cursepy.readthedocs.io/en/latest/advn/hand.html)!
127
127
128
128
## Curse Instances
@@ -161,10 +161,12 @@ Have a look at the [Wrapper Tutorial](https://cursepy.readthedocs.io/en/latest/b
161
161
162
162
You can install cursepy via pip:
163
163
164
-
$ pip install cursepy
164
+
```bash
165
+
pip install cursepy
166
+
```
165
167
166
168
For more information on installing cursepy,
167
-
check out the installation section in our [documentation](https://cursepy.readthedocs.io/en/latest/install.html).
169
+
check out the installation section in our [documentation](https://cursepy.readthedocs.io/en/latest/install.html).
168
170
169
171
# Documentation
170
172
@@ -181,14 +183,14 @@ The documentation is built using [sphinx](https://www.sphinx-doc.org/en/master/i
181
183
Building the docs yourself is very simple.
182
184
You can start by installing sphinx:
183
185
184
-
```
186
+
```bash
185
187
pip install sphinx
186
188
```
187
189
188
190
Now, navigate to the 'docs' directory in your favorite terminal.
189
191
Next, you can issue the 'make' command to build the docs:
190
192
191
-
```
193
+
```bash
192
194
make html
193
195
```
194
196
@@ -220,4 +222,4 @@ Sally Miller - Proof reading
220
222
221
223
cursepy offers a pythonic, intuitive way to interact with CurseForge projects!
0 commit comments