Skip to content

Commit d0cc5bc

Browse files
SoheabSoheab
committed
📚 Revamps and clarifies documentation for all modules ✍️
✨ Improves consistency and formatting across all docs 📖 Restructures reference material for easier reading 🛠️ Expands method and model explanations 📊 Adds tables, links, and clearer attribute descriptions 🚀 Enhances onboarding and overall usability for both new and experienced users 🎉
1 parent 16922e8 commit d0cc5bc

File tree

11 files changed

+543
-455
lines changed

11 files changed

+543
-455
lines changed

‎README.md

+29-16
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,54 @@
11
[![Downloads Total](https://pepy.tech/badge/alexflipnote-py)](https://pepy.tech/project/alexflipnote-py)
22
[![Downloads Month](https://pepy.tech/badge/alexflipnote-py/month)](https://pepy.tech/project/alexflipnote-py)
33
[![Downloads Week](https://pepy.tech/badge/alexflipnote-py/week)](https://pepy.tech/project/alexflipnote-py)
4-
[![PyPi Version](https://img.shields.io/pypi/v/alexflipnote.py.svg)](https://pypi.python.org/pypi/alexflipnote.py/)
4+
[![PyPI Version](https://img.shields.io/pypi/v/alexflipnote.py.svg)](https://pypi.python.org/pypi/alexflipnote.py/)
55
[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs)
66

77
# AlexFlipnote.py
88

9-
An easy-to-use Python Wrapper for the AlexFlipnote API
9+
An easy-to-use Python Wrapper for the [AlexFlipnote API][base_url].
10+
11+
## Features
12+
13+
- Easy-to-use asynchronous interface
14+
- Supports all public API endpoints
15+
- Actively maintained and documented
1016

1117
## Requirements
1218

13-
- Python 3.8 or above
14-
- aiohttp (``python -m pip install -U aiohttp``)
19+
- Python 3.8+
20+
- [`aiohttp`](https://pypi.org/project/aiohttp/) (`python -m pip install -U aiohttp`)
1521

1622
## Installation
1723

18-
Install the package by doing one of the following commands:
19-
20-
**Using pip (recommended)**:
24+
Install via pip:
2125

22-
- `pip install alexflipnote.py -U`
23-
- `python -m pip install alexflipnote.py -U`
26+
```sh
27+
pip install -U alexflipnote.py
28+
# or
29+
python -m pip install -U alexflipnote.py
30+
# or
31+
python -m pip install -U git+https://github.com/soheab/alexflipnote.py
32+
```
2433

2534
## Documentation
2635

27-
See the full and detailed [docs here][docs]
36+
Full documentation is available [here][docs].
2837

29-
## Links
38+
## Useful Links
3039

31-
[API][base_url] | [Changelogs][changelog] | [Examples][examples] | [Github][github] | [PyPi][pypi]
40+
- [API][base_url]
41+
- [Changelog][changelog]
42+
- [Examples][examples]
43+
- [GitHub][github]
44+
- [PyPI][pypi]
3245

33-
## Made by
46+
## Support
3447

35-
This wrapper is made by **Soheab_#6240** (150665783268212746), DM me on Discord or join my server [here][discord_mine]
36-
for anything related to this wrapper.
48+
Made by **Soheab_** (150665783268212746).
49+
For questions or support, DM me on Discord or join my server [here][discord_mine].
3750

38-
Join AlexFlipnote's server [here][discord_alexflipnote] to suggest or report anything on the API.
51+
For API suggestions or issues, join the official AlexFlipnote server [here][discord_alexflipnote].
3952

4053
[docs]: start-docs.md
4154
[changelog]: https://github.com/Soheab/alexflipnote.py/blob/master/changelog.md

‎alexflipnote/models/http.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111

1212
class HTTPResult:
13-
"""Represents an HTTP result.
13+
"""Represents the result from the /http endpoint.
1414
1515
Attributes
1616
----------

‎changelog.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## AlexFlipnote.py | Changelog
2-
See here what changed or broke each version.
1+
## Changelog
2+
See here what changes (or breaks) every version.
33

44
---
55

‎docs/enums.md

+67-64
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,72 @@
1-
# AlexFlipnote.py Docs | Enums
1+
# MinecraftIcon
2+
Represents available Minecraft icons for use with the Minecraft endpoints (`achievement`, `challenge`).
23

3-
## MinecraftIcon
4-
Minecraft icons for the Minecraft endpoints. (achievement, challenge)
4+
## Attributes
55

6-
### Attributes
7-
- GRASS_BLOCK *(or GRASSBLOCK or 1)*
8-
- DIAMOND *(or 2)*
9-
- DIAMOND_SWORD *(or DIAMONDSWORD or 3)*
10-
- CREEPER *(or 4)*
11-
- PIG *(or 5)*
12-
- TNT *(or 6)*
13-
- COOKIE *(or 7)*
14-
- HEART *(or 8)*
15-
- BED *(or 9)*
16-
- CAKE *(or 10)*
17-
- SIGN *(or 11)*
18-
- RAIL *(or 12)*
19-
- CRAFTING_BENCH *(or CRAFTINGBENCH or 13)*
20-
- REDSTONE *(or 14)*
21-
- FIRE *(or 15)*
22-
- COBWEB *(or 16)*
23-
- CHEST *(or 17)*
24-
- FURNACE *(or 18)*
25-
- BOOK *(or 19)*
26-
- STONE_BLOCK *(or STONEBLOCK or 20)*
27-
- WOODEN_PLANK_BLOCK *(or WOODENPLANKBLOCK or 21)*
28-
- IRON_INGOT *(or IRONINGOT or 22)*
29-
- GOLD_INGOT *(or GOLDINGOT or 23)*
30-
- WOODEN_DOOR *(or WOODENDOOR or 24)*
31-
- IRON_DOOR *(or IRONDOOR or 25)*
32-
- DIAMOND_CHESTPLATE *(or DIAMONDCHESTPLATE or 26)*
33-
- FLINT_AND_STEEL *(or FLINTANDSTEEL or 27)*
34-
- GLASS_BOTTLE *(or GLASSBOTTLE or 28)*
35-
- SPLASH_POTION *(or SPLASHPOTION or 29)*
36-
- CREEPER_SPAWNEGG *(or CREEPERSPAWNEGG or 30)*
37-
- COAL *(or 31)*
38-
- IRON_SWORD *(or IRONSWORD or 32)*
39-
- BOW *(or 33)*
40-
- ARROW *(or 34)*
41-
- IRON_CHESTPLATE *(or IRONCHESTPLATE or 35)*
42-
- BUCKET *(or 36)*
43-
- BUCKET_WITH_WATER *(or BUCKETWITHWATER or 37)*
44-
- BUCKET_WITH_LAVA *(or BUCKETWITHLAVA or 38)*
45-
- BUCKET_WITH_MILK *(or BUCKETWITHMILK or 39)*
46-
- DIAMOND_BOOTS *(or DIAMONDBOOTS or 40)*
47-
- WOODEN_HOE *(or WOODENHOE or 41)*
48-
- BREAD *(or 42)*
49-
- WOODEN_SWORD *(or WOODENSWORD or 43)*
50-
- BONE *(or 44)*
51-
- OAK_LOG *(or OAKLOG or 45)*
52-
- RANDOM *(or 46)*
6+
| Name | Aliases | Value |
7+
| ------------------ | ----------------- | ----- |
8+
| GRASS_BLOCK | GRASSBLOCK | 1 |
9+
| DIAMOND | | 2 |
10+
| DIAMOND_SWORD | DIAMONDSWORD | 3 |
11+
| CREEPER | | 4 |
12+
| PIG | | 5 |
13+
| TNT | | 6 |
14+
| COOKIE | | 7 |
15+
| HEART | | 8 |
16+
| BED | | 9 |
17+
| CAKE | | 10 |
18+
| SIGN | | 11 |
19+
| RAIL | | 12 |
20+
| CRAFTING_BENCH | CRAFTINGBENCH | 13 |
21+
| REDSTONE | | 14 |
22+
| FIRE | | 15 |
23+
| COBWEB | | 16 |
24+
| CHEST | | 17 |
25+
| FURNACE | | 18 |
26+
| BOOK | | 19 |
27+
| STONE_BLOCK | STONEBLOCK | 20 |
28+
| WOODEN_PLANK_BLOCK | WOODENPLANKBLOCK | 21 |
29+
| IRON_INGOT | IRONINGOT | 22 |
30+
| GOLD_INGOT | GOLDINGOT | 23 |
31+
| WOODEN_DOOR | WOODENDOOR | 24 |
32+
| IRON_DOOR | IRONDOOR | 25 |
33+
| DIAMOND_CHESTPLATE | DIAMONDCHESTPLATE | 26 |
34+
| FLINT_AND_STEEL | FLINTANDSTEEL | 27 |
35+
| GLASS_BOTTLE | GLASSBOTTLE | 28 |
36+
| SPLASH_POTION | SPLASHPOTION | 29 |
37+
| CREEPER_SPAWNEGG | CREEPERSPAWNEGG | 30 |
38+
| COAL | | 31 |
39+
| IRON_SWORD | IRONSWORD | 32 |
40+
| BOW | | 33 |
41+
| ARROW | | 34 |
42+
| IRON_CHESTPLATE | IRONCHESTPLATE | 35 |
43+
| BUCKET | | 36 |
44+
| BUCKET_WITH_WATER | BUCKETWITHWATER | 37 |
45+
| BUCKET_WITH_LAVA | BUCKETWITHLAVA | 38 |
46+
| BUCKET_WITH_MILK | BUCKETWITHMILK | 39 |
47+
| DIAMOND_BOOTS | DIAMONDBOOTS | 40 |
48+
| WOODEN_HOE | WOODENHOE | 41 |
49+
| BREAD | | 42 |
50+
| WOODEN_SWORD | WOODENSWORD | 43 |
51+
| BONE | | 44 |
52+
| OAK_LOG | OAKLOG | 45 |
53+
| RANDOM | | 46 |
5354

54-
---
55+
# NFTSeason
5556

56-
## NFTSeason
57-
Seasons for the NFT endpoint.
57+
Represents the available seasons for the NFT endpoint.
5858

59-
### Attributes
60-
- NONE *(or none)*
61-
- APRIL *(or april)*
62-
- AUTUMN *(or autumn)*
63-
- CHRISTMAS *(or christmas)*
64-
- HALLOWEEN *(or halloween)*
65-
- NORWAY *(or norway)*
66-
- SPRING *(or spring)*
67-
- SUMMER *(or summer)*
68-
- WINTER *(or winter)*
69-
- RANDOM *(or random)*
59+
## Attributes
60+
61+
| Name | Value |
62+
| --------- | --------- |
63+
| NONE | none |
64+
| APRIL | april |
65+
| AUTUMN | autumn |
66+
| CHRISTMAS | christmas |
67+
| HALLOWEEN | halloween |
68+
| NORWAY | norway |
69+
| SPRING | spring |
70+
| SUMMER | summer |
71+
| WINTER | winter |
72+
| RANDOM | random |

0 commit comments

Comments
 (0)