A fully typed configparser for python

Ankit Jain — Wed, 24 Jan 2024 13:30:51 +0000

typed-configparser

typed-configparser is an extension of the standard configparser module with support for typed configurations using dataclasses.
It leverages Python's type hints and dataclasses to provide a convenient way of parsing and validating configuration files.

Features

✓ Fully typed.
✓ Use dataclasses to parse the configuration file.
✓ Support for almost all python built-in data types - int, float, str, list, tuple, dict and complex data types using Union and Optional.
✓ Built on top of configparser, hence retains all functionalities of configparser.
✓ Support for optional values (optional values are automatically set to None if not provided).
✓ Smarter defaults.

Usage

examples/basic.py

# This is a complete example and should work as is

from typing import List
from typed_configparser import ConfigParser
from dataclasses import dataclass


@dataclass
class BASIC:
    option1: int
    option2: str
    option3: float
    option4: List[str]


config = """
[BASIC]
option1 = 10
option2 = value2
option3 = 5.2
option4 = [foo,bar]
"""

parser = ConfigParser()
parser.read_string(config)
section = parser.parse_section(using_dataclass=BASIC)

print(section)

BASIC(option1=10, option2=value2, option3=5.2, option4=['foo', 'bar'])

examples/unions_and_optionals.py

# This is a complete example and should work as is

from typing import List, Union, Optional, Dict, Tuple
from typed_configparser import ConfigParser
from dataclasses import dataclass, field


@dataclass
class DEFAULT_EXAMPLE:
    option1: int
    option2: Union[List[Tuple[str, str]], List[int]]
    option3: Dict[str, str] = field(default_factory=lambda: {"default_key": "default_value"})
    option4: Optional[float] = None


config = """
[DEFAULT]
option1 = 20
option2 = default_value2

[MY_SECTION_1]
option2 = [10,20]
option4 = 5.2

[MY_SECTION_2]
option2 = [(value2a, value2b), (value2c, value2b), (value2c, value2d)]
option3 = {key: value}
option4 = none
"""

parser = ConfigParser()
parser.read_string(config)
my_section_1 = parser.parse_section(using_dataclass=DEFAULT_EXAMPLE, section_name="MY_SECTION_1")
my_section_2 = parser.parse_section(using_dataclass=DEFAULT_EXAMPLE, section_name="MY_SECTION_2")

print(my_section_1)
print(my_section_2)

DEFAULT_EXAMPLE(option1=20, option2=[10, 20], option3={'default_key': 'default_value'}, option4=5.2)
DEFAULT_EXAMPLE(option1=20, option2=[('value2a', 'value2b'), ('value2c', 'value2b'), ('value2c', 'value2d')], option3={'key': 'value'}, option4=None)

Check the github repo for more details.

A new & improved Swagger UI theme

Ankit Jain — Tue, 16 Jan 2024 15:34:04 +0000

swagger-ui-improved-theme

Welcome to Swagger UI Improved Theme, a project aimed at enhancing the visual appeal of Swagger UI documentation. If you've ever found Swagger UI to be a bit bland and in need of a facelift, you're in the right place. This theme strives to make Swagger UI documentation look cooler and more visually engaging. Be sure to check out the screenshots to see the theme in action!

Note

The theme is designed to work seamlessly with OpenAPI v3 and above.
It also provides support for Swagger v2, though it may not be fully tested. Most features should work fine, but keep in mind that future updates will focus primarily on v3 and above.
In the event that a change in the OpenAPI specification breaks compatibility with Swagger v2, it will not be actively addressed in future updates.

How to use?

Using the Swagger UI Improved Theme is a breeze. You have two options:

Download Locally:
- Simply download the CSS file from this repository and include it in your project.

Use a CDN - jsDelivr:

Copy and paste the following URL into your project:

 https://cdn.jsdelivr.net/gh/ajatkj/swagger-ui-improved-theme/css/swagger-ui-improved.css

This allows you to seamlessly integrate the theme into your Swagger UI documentation without the need to host the file yourself.

Screenshots

Contributions

If you're passionate about improving Swagger UI documentation and have ideas for enhancements, feel free to contribute to this project. Open-source thrives on collaboration, and your input could make a significant impact.

Conclusion

Swagger UI Improved Theme aims to inject style and modern aesthetics into your API documentation. Whether you're working with OpenAPI v3 or Swagger v2, this theme provides an opportunity to showcase your API in a visually appealing way. Download it, give it a try, and let your Swagger UI documentation stand out from the crowd!

DEV Community: Ankit Jain