معرفی شرکت ها
configur8-2.0.1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Type-safe configuration and validation library
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | configur8-2.0.1 |
| نام | configur8 |
| نسخه کتابخانه | 2.0.1 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | - |
| ایمیل نویسنده | Nick Joyce <nick@stratuscode.com> |
| آدرس صفحه اصلی | - |
| آدرس اینترنتی | https://pypi.org/project/configur8/ |
| مجوز | MIT |
configur8
=========
Python type-safe configuration and validation library.
## Introduction
Configuration validation is a common problem in Python. This library aims to
provide a simple, type-safe way to validate configuration either by file or
environment variables.
An example:
/path/to/config.yaml:
```yaml
mysql:
host: localhost
port: 3306
user: not_root
password: my_password
```
```python
import configur8
from configur8 import env
class MySQL:
# define the fields and their types
host: str
# default values are supported
port: int = 3306
# default values can programmatically be defined, e.g. from an env var
user: str = env.str("MYSQL_USER", "definitely_not_root")
password: str
class Config:
mysql: MySQL
config = configur8.load(Config, "/path/to/config.yaml")
assert isinstance(config.mysql, MySQL) # True
```
The above example will load the configuration from the file at
``/path/to/config.yaml`` and validate it against the ``Config`` class. If the
configuration is invalid, an exception will be raised.
## Environment only
An example:
```python
from configur8 import env
SECRET_KEY = env.str("SECRET_KEY")
NUM_WORKERS = env.int("NUM_WORKERS", 2)
DEBUG = env.bool("DEBUG", False)
```
In the example above:
1. ``SECRET_KEY`` is a required environment variable - attempting execute the
code without it defined will result in an exception. This is typically what
you want so that apps and services don't start in an unintended state.
2. ``NUM_WORKERS`` will be parsed into an integer. If the env var is not
defined, ``2`` will be used as a default. If a non integer value is parsed,
an error will be raised.
3. ``DEBUG`` is a boolean with a default of ``False``. "Truthy" values can be
used, e.g. "on", "1", etc.
Everything is designed to be type safe.
## Types of values supported
* String - ``env.str``
* Integer - ``env.int``
* Float - ``env.float``
* Boolean - ``env.bool``
* Url - ``env.url``
* Path - ``env.path``
* Email - ``env.email`` - Validation provided by ``email-validator``
Each type can support optional values and work with lists:
```python
from configur8 import env
ALLOWED_HOSTS = env.url.list("ALLOWED_HOSTS")
```
Given the environment:
```
ALLOWED_HOSTS=http://localhost,http://my-staging-server
```
The python value of ``ALLOWED_HOSTS`` would be:
```python
["http://localhost", "http://my-staging-server"]
```
## Boolean flags
Boolean values are supported. See ``configur8.env.BOOLEAN_TRUTHY_VALUES``:
* `true`
* `1`
* `on`
* `yes`
* `ok`
Will all result in a ``True`` Python value. Anything else will result in
``False``.
## Urls
These are augmented objects that have extra attributes in case you need them:
```python
from configur8 import env
# https://my-bucket.s3.us-west-2.amazonaws.com
bucket = env.url("S3_BUCKET_URL")
assert bucket.protocol == "https"
assert bucket.host == "my-bucket.s3.us-west-2.amazonaws.com"
```
There are a bunch more properties - see ``configur8.url.Url``.
## Paths
These are augmented objects that have extra attributes in case you need them:
```python
from configur8 import env
# /var/run/secrets/my-mounted-volume/my-secret
my_creds = env.path("SERVICE_CREDS").read()
# my_creds will hold the contents of the file in the env var
```
## Development
1. [Install PDM](https://pdm.fming.dev/latest/)
2. [Install Task](https://taskfile.dev/installation/)
### Running tests
```shell
task test
```
### Publishing to PyPI
**NOTE** Replace `__VERSION__` with a semver identifier such as `0.9.3`
1. Ensure that you are on a clean master.
2. Update `__version__` in `src/configur8/__about__.py` to `__VERSION__`.
3. Update `CHANGELOG.md` with the new version and changes.
4. ```shell
git add src/configur8/__about__.py CHANGELOG.md
git commit -m "Bump to __VERSION__"
git tag v__VERSION__
git push origin --tags
5. Wait for Github Actions to succeed and publish the library to the public PyPI.
نیازمندی
| مقدار | نام |
|---|---|
| - | email-validator>=1.3.1 |
| - | typing-extensions>=4.0.0 |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.7,<4.0 | Python |
نحوه نصب
نصب پکیج whl configur8-2.0.1:
pip install configur8-2.0.1.whl
نصب پکیج tar.gz configur8-2.0.1:
pip install configur8-2.0.1.tar.gz