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
Update project README.
Another refactor, move all utils out of red_utils.utils and into red_utils.std and red_utils.ext.
red_utils.std: Utils for the stdlib, with no external dependencies.
red_utils.ext: Utils for 3rd party libraries like fastapi, sqlalchemy, etc
Copy file name to clipboardExpand all lines: README.md
+49-1
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,14 @@
1
1
# red-utils
2
2
3
-
**Important**: This is my first Python package. I'm experimenting with CI/CD and Pypi. This library is most likely not useful to anyone else.
3
+
⚠️**Important**⚠️: This is my first Python package. I'm experimenting with CI/CD and Pypi. This library is most likely not useful to anyone else, may be broken at times, may undergo refactors with little to no notice/documentation, and all that other awful stuff that comes with being an amateur developer doing this in their free time 🙃
A collection of utility scripts/functions that I use frequently. Includes helper functions/default variables for libraries like `loguru`, `diskcache`, and `msgpack`.
11
19
20
+
21
+
12
22
# Installation
13
23
24
+
This project uses dependencies groups, meaning it can be installed with `pip install red-utils` for the base package, or with dependency groups like `pip install red-utils[all]` (to install all packages with a corresponding red-util module), `pip install red-utils[http]` (to install some helpful packages for HTTP requests, i.e. `httpx` and `diskcache`), and more.
25
+
26
+
## Dependency groups:
27
+
28
+
*Note*: I will do my best to update this, but to get an accurate view of available dependency groups and the packages that will be installed, check the [`pyproject.toml`](./pyproject.toml) file. Look for the dependency lists, i.e. `dependencies = [` (the base set of dependencies), `all = [`, `http = [`, etc.
29
+
30
+
`[all]`
31
+
32
+
-`diskcache`
33
+
-`fastapi`
34
+
-`uvicorn[standard]`
35
+
-`loguru`
36
+
-`httpx`
37
+
-`msgpack`
38
+
-`pendulum`
39
+
40
+
`[fastapi]`
41
+
42
+
-`fastapi`
43
+
-`sqlalchemy`
44
+
-`loguru`
45
+
-`httpx`
46
+
-`msgpack`
47
+
-`uvicorn`
48
+
-`pendulum`
49
+
50
+
`[http]`
51
+
52
+
-`httpx`
53
+
-`diskcache`
54
+
-`loguru`
55
+
-`pendulum`
56
+
-`msgpack`
57
+
14
58
## Pip
15
59
16
60
`pip install red-utils`
@@ -21,6 +65,10 @@ A collection of utility scripts/functions that I use frequently. Includes helper
21
65
22
66
# Modules
23
67
68
+
*note*: The list below is most likely not complete or up todate. I update it as I think about it, but add new modules & refactor more frequently than I remember to update this section, and I haven't started learning any fancy auto-documentation libraries.
69
+
70
+
For a complete overview of available modules and their functions, check [`red_utils/std`](./red_utils/std) (utilities with no dependencies, to enhance the stdlib, i.e. `dict_utils` and `path_utils`) and [`red_utils/ext`](./red_utils/ext) (utilities that extend a 3rd party module, i.e. `httpx_utils`, `sqlalchemy_utils`, etc).
71
+
24
72
## dict_utils
25
73
26
74
**Description**: Helper functions to assist repetitive `dict`-related operations.
0 commit comments