ZOG Utils
Utilities to use in my base-api project template. https://github.com/tienhm0202/base-fastapi/
Why ZOG? Because I can't named it as utils only, so I have to add a prefix.
ZOG sounds like joke and looks like zoo. I found that funny enough to use.
Usage
$ pip install zogutils
To generate short unique id string
from zogutils import secret
secret.unique_id(8, "ID_")
# return: ID_a7uFg9k0
To shorten package name like Java's Logback
from zogutils import package_name
package_name.shorten("company.scope.modules.Function", 9)
# return: (something like) c.s.m.Function - depends on max length
To init some middlewares
from zogutils import middlewares
from your.app import settings, fastapi_app
middlewares.init_app(fastapi_app, settings)
Configs:
# Sentry
SENTRY_DSN: Optional[HttpUrl] = None
SENTRY_INCLUDE: Optional[List[str]] = ["src"]
SENTRY_SAMPLE_RATE: Optional[float] = 0.5
# CSRF
SECURITY_CSRF: bool = False
# Rate limit
RATE_LIMIT: int = 100
RATE_LIMIT_TIME_SPAN: int = 30
RATE_LIMIT_BLOCK_DURATION: int = 300
# Prometheus
PROMETHEUS_ENABLE: bool = True
PROMETHEUS_PATH: str = "/metrics/"
# Cors
BACKEND_CORS_ORIGINS: List[AnyHttpUrl] = []
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
zogutils-1.5.1.tar.gz
(5.1 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file zogutils-1.5.1.tar.gz.
File metadata
- Download URL: zogutils-1.5.1.tar.gz
- Upload date:
- Size: 5.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.1.4 CPython/3.8.6 Darwin/20.2.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
30573bcb88581b00e29adfb43f41ec9b20f663659c92d9afff2133365168e716
|
|
| MD5 |
a268d6bf1a94abe5f299559a6e1daaf8
|
|
| BLAKE2b-256 |
6cc374640a4b7a415ee031ec1dfb1ffec0be13037d4d2a6b01cca573dbafa45a
|
File details
Details for the file zogutils-1.5.1-py3-none-any.whl.
File metadata
- Download URL: zogutils-1.5.1-py3-none-any.whl
- Upload date:
- Size: 6.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.1.4 CPython/3.8.6 Darwin/20.2.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
356db3f977cf30d0a32a1aff481463c8768844080d81bd81ecc478c3abe9b47d
|
|
| MD5 |
d0d4c4d1eea72118b9db5ae819bcce0a
|
|
| BLAKE2b-256 |
45748c5f073368314313ab18cac787a6dc472133535a2efefafe0038dde5dd3b
|