Habiticalib 0.1.0a0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- habiticalib/__init__.py +12 -0
- habiticalib/const.py +14 -0
- habiticalib/exceptions.py +27 -0
- habiticalib/helpers.py +115 -0
- habiticalib/lib.py +1538 -0
- habiticalib/py.typed +0 -0
- habiticalib/types.py +1202 -0
- habiticalib-0.1.0a0.dist-info/METADATA +92 -0
- habiticalib-0.1.0a0.dist-info/RECORD +11 -0
- habiticalib-0.1.0a0.dist-info/WHEEL +4 -0
- habiticalib-0.1.0a0.dist-info/licenses/LICENSE +22 -0
@@ -0,0 +1,92 @@
|
|
1
|
+
Metadata-Version: 2.3
|
2
|
+
Name: Habiticalib
|
3
|
+
Version: 0.1.0a0
|
4
|
+
Summary: Asynchronous Python client library for the Habitica API
|
5
|
+
Project-URL: Documentation, https://tr4nt0r.github.io/habiticalib/
|
6
|
+
Project-URL: Source, https://github.com/tr4nt0r/habiticalib
|
7
|
+
Author-email: Manfred Dennerlein Rodelo <manfred@dennerlein.name>
|
8
|
+
License: MIT License
|
9
|
+
License-File: LICENSE
|
10
|
+
Classifier: License :: OSI Approved :: MIT License
|
11
|
+
Classifier: Operating System :: OS Independent
|
12
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
13
|
+
Requires-Python: >=3.12
|
14
|
+
Requires-Dist: aiohttp~=3.9
|
15
|
+
Requires-Dist: mashumaro~=3.13
|
16
|
+
Requires-Dist: orjson~=3.10
|
17
|
+
Requires-Dist: pillow~=10.4
|
18
|
+
Description-Content-Type: text/markdown
|
19
|
+
|
20
|
+
# Habiticalib
|
21
|
+
|
22
|
+
<p align="center">
|
23
|
+
<em>Modern asynchronous Python client library for the Habitica API</em>
|
24
|
+
</p>
|
25
|
+
|
26
|
+
[](https://github.com/tr4nt0r/habiticalib/actions)
|
27
|
+
[](https://codecov.io/gh/tr4nt0r/habiticalib)
|
28
|
+
[](https://badge.fury.io/py/habiticalib)
|
29
|
+
|
30
|
+
---
|
31
|
+
|
32
|
+
**Documentation**: <a href="https://tr4nt0r.github.io/habiticalib/" target="_blank">https://tr4nt0r.github.io/habiticalib/</a>
|
33
|
+
|
34
|
+
**Source Code**: <a href="https://github.com/tr4nt0r/habiticalib" target="_blank">https://github.com/tr4nt0r/habiticalib</a>
|
35
|
+
|
36
|
+
---
|
37
|
+
|
38
|
+
## Development
|
39
|
+
|
40
|
+
### Setup environment
|
41
|
+
|
42
|
+
We use [Hatch](https://hatch.pypa.io/latest/install/) to manage the development environment and production build. Ensure it's installed on your system.
|
43
|
+
|
44
|
+
### Run unit tests
|
45
|
+
|
46
|
+
You can run all the tests with:
|
47
|
+
|
48
|
+
```bash
|
49
|
+
hatch run test
|
50
|
+
```
|
51
|
+
|
52
|
+
### Format the code
|
53
|
+
|
54
|
+
Execute the following command to apply linting and check typing:
|
55
|
+
|
56
|
+
```bash
|
57
|
+
hatch run lint
|
58
|
+
```
|
59
|
+
|
60
|
+
### Publish a new version
|
61
|
+
|
62
|
+
You can bump the version, create a commit and associated tag with one command:
|
63
|
+
|
64
|
+
```bash
|
65
|
+
hatch version patch
|
66
|
+
```
|
67
|
+
|
68
|
+
```bash
|
69
|
+
hatch version minor
|
70
|
+
```
|
71
|
+
|
72
|
+
```bash
|
73
|
+
hatch version major
|
74
|
+
```
|
75
|
+
|
76
|
+
Your default Git text editor will open so you can add information about the release.
|
77
|
+
|
78
|
+
When you push the tag on GitHub, the workflow will automatically publish it on PyPi and a GitHub release will be created as draft.
|
79
|
+
|
80
|
+
## Serve the documentation
|
81
|
+
|
82
|
+
You can serve the Mkdocs documentation with:
|
83
|
+
|
84
|
+
```bash
|
85
|
+
hatch run docs-serve
|
86
|
+
```
|
87
|
+
|
88
|
+
It'll automatically watch for changes in your code.
|
89
|
+
|
90
|
+
## License
|
91
|
+
|
92
|
+
This project is licensed under the terms of the MIT license.
|
@@ -0,0 +1,11 @@
|
|
1
|
+
habiticalib/__init__.py,sha256=veWNJO9Y1tearAF3GXOM3PZgGxqE1Ku3vpMcuFpQWIk,301
|
2
|
+
habiticalib/const.py,sha256=HeIl1dPAeAxt1V-9PkPCt60ThAJJWkUKpCzMEEAR-ik,584
|
3
|
+
habiticalib/exceptions.py,sha256=V7QAPQM4HbGxq7-BYDSdG9Zi2u9F2w3tX8XwualJbWM,601
|
4
|
+
habiticalib/helpers.py,sha256=1PEq8tjOgotMnGRUcRcFcLCEa7jFWUORD9ZPHEVH2sU,3527
|
5
|
+
habiticalib/lib.py,sha256=FlQUFX1jvbznJLcd1M7xQ7YxAXuU2GAl3R4KMZwefJM,53749
|
6
|
+
habiticalib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
7
|
+
habiticalib/types.py,sha256=r_5pCRdfZRv7whryAgVOUnqv4qUGfokgq9GqdkdK_y8,32549
|
8
|
+
habiticalib-0.1.0a0.dist-info/METADATA,sha256=7rJ5r71bY1A5mz50twmXizvs9pX5xpCvivJWqaoXIUs,2471
|
9
|
+
habiticalib-0.1.0a0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
|
10
|
+
habiticalib-0.1.0a0.dist-info/licenses/LICENSE,sha256=oIinIOSJ49l1iVIRI3XGXFWt6SF7a83kEFBAY8ORwNI,1084
|
11
|
+
habiticalib-0.1.0a0.dist-info/RECORD,,
|
@@ -0,0 +1,22 @@
|
|
1
|
+
MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2024, Manfred Dennerlein Rodelo
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
22
|
+
|