untils 1.0.0__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.
- untils/__init__.py +28 -0
- untils/command.py +130 -0
- untils/command_system.py +403 -0
- untils/commands_config.py +23 -0
- untils/config_validator.py +616 -0
- untils/factories.py +40 -0
- untils/input_token.py +104 -0
- untils/input_validator.py +556 -0
- untils/ioreader.py +55 -0
- untils/iovalidator.py +55 -0
- untils/parser.py +138 -0
- untils/processor.py +88 -0
- untils/settings.py +114 -0
- untils/tokenizer.py +108 -0
- untils/utils/__init__.py +22 -0
- untils/utils/constants.py +267 -0
- untils/utils/decorators.py +47 -0
- untils/utils/enums.py +48 -0
- untils/utils/lib_warnings.py +43 -0
- untils/utils/protocols.py +42 -0
- untils/utils/type_aliases.py +88 -0
- untils-1.0.0.dist-info/METADATA +73 -0
- untils-1.0.0.dist-info/RECORD +26 -0
- untils-1.0.0.dist-info/WHEEL +5 -0
- untils-1.0.0.dist-info/licenses/README.md +50 -0
- untils-1.0.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Welcome to `untils`
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
*untils* - Is light-weight library for console games or small utils to process user input as commands and describe structure with config.
|
|
8
|
+
|
|
9
|
+
## Abilities
|
|
10
|
+
|
|
11
|
+
- Module-based config in markup line.
|
|
12
|
+
- Custom logic in OOP.
|
|
13
|
+
- Validation and parsing user input for 10 lines.
|
|
14
|
+
- Process exceptions.
|
|
15
|
+
- Almost-perfect detailed annotations everywhere.
|
|
16
|
+
- Fast command processing (~208µs).
|
|
17
|
+
- Infinitely extendable abilities.
|
|
18
|
+
- Calm about anything.
|
|
19
|
+
|
|
20
|
+
## Architecture
|
|
21
|
+
|
|
22
|
+
This library was builded with next architecture:
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
## Installation
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
pip install untils
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Documentation
|
|
33
|
+
|
|
34
|
+
[Start Course](start-guide/01-first-project.md "Beginner course into the library.")
|
|
35
|
+
|
|
36
|
+
[API Reference](api-reference.md)
|
|
37
|
+
|
|
38
|
+
## Roadmap
|
|
39
|
+
|
|
40
|
+
I have resolve my thoughs to several categories:
|
|
41
|
+
|
|
42
|
+
1. **Main**:
|
|
43
|
+
- [ ] Add command description in `"description"` field.
|
|
44
|
+
- [ ] Add reserved commands in format like internal state name: `"__help__"` - Get all and available commands.
|
|
45
|
+
|
|
46
|
+
2. **Additional**:
|
|
47
|
+
- [ ] ...
|
|
48
|
+
|
|
49
|
+
3. **Conceptions**:
|
|
50
|
+
- [ ] Typing system in config through `"type"` field.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
untils
|