semvec/pypi-packages huggingface dataset:
CosmoDocs 0.2.6
A file based documentation generator for Python projects.
License: MIT
Requires Python: >=3.9

# Cosmo Docs

<p align="center">
  <img src="https://raw.githubusercontent.com/Strovsk/CosmoDocs/main/docs/image/Cosmo%20Docs%20Logo.png" />
</p>

Cosmo Docs is a powerful package that serves as a parser for describing functions and classes in a Python script. It provides detailed information about functions and classes, and can generate the information in markdown format. This makes it easy to document and share code documentation in a standardized and readable format.

With Cosmo Docs, you can effortlessly extract information about the structure, parameters, and return values of functions and classes in your Python code. This package is particularly useful for generating documentation for libraries, frameworks, and large codebases, where maintaining up-to-date documentation can be a challenging task.

Whether you are a developer looking to document your own code or a user exploring a Python package, Cosmo Docs simplifies the process of understanding and utilizing the available functions and classes. By providing clear and concise documentation in markdown format, Cosmo Docs enhances code readability and promotes collaboration among developers.

Get started with Cosmo Docs today and unlock the power of comprehensive code documentation!

# Getting Started

## Installation

To install Cosmo Docs, run the following command:

```bash
pip install cosmo-docs
```

## Usage

To use Cosmo Docs, import the `CosmoDocs` class from `cosmo_docs` module.

```python
from cosmo_docs import CosmoDocs

cosmos = CosmosDocs("tests/data/sample_file.py")

# to get the file information in CosmoDocsInfo dict format
# if you want use it for easy intellisense: from cosmo_docs import CosmoDocsInfo
print(cosmos.file_info)

# to get the file information in markdown format
print(cosmos.markdown)
```

> Note: You can create your own formats from `comos.file_info` dict.
hyperconf 0.3.0
YAML-based configuration library, featuring zero-code validation and parsing.
License: MIT
Requires Python: <4.0.0,>=3.8.1

# HyperConfig

[![Build Status](https://travis-ci.org/your-username/hyperconfig.svg?branch=main)](https://travis-ci.org/rchindris/hyperconfig)
[![PyPI version](https://badge.fury.io/py/hyperconfig.svg)](https://badge.fury.io/py/hyperconfig)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)

## Overview

HyperConfig is a Python library for creating schema-based configuration files.
It automatically parses parses, validates and converts configuration objects 
according to a predefined configuration schema.


Advantages:

- less code: define the structure in YAML, validate and load configs using a one-liner.
- shared schemas: define once, use in multiple projects.
- extensibility: add configuration types and validation rules without coding.

## Installation

```bash
pip install hyperconf

```

## Usage

Define your schema in a definition file, `ships.yaml`:

``` yaml
  # Spaceship Configuration Schema
  ship_type:
    type: str
    validator: hval.isalpha()
    required: true

  shipcolor:
    type: str
    validator: hval.lower() in ['red', 'blue', 'green', 'yellow', 'gray']
    required: true

  enginepower:
    type: int
    validator: 100 <= hval <= 1000
    required: true

  shieldlevel:
    type: percent
    required: true

  ship:
    captain: str
    crew:
      type: int
      validator: hval > 0
    class: shiptype
    color: shipcolor
    shields: shieldlevel
    engines: enginepower
```

Then use the schema to create configuration values, `gameconfig.yaml`:

``` yaml
use: ships

ncc1701=ship:
  captain: James T. Kirk
  crew: 203
  class: constitution
  color: gray
  shields: 1.0
  engines: 900
```

and load it:

``` python
>>> from hyperconfig import HyperConf
>>> config = HyperConf.load("gameconfig.yaml")
>>> print(config.ncc1701.captain)
```

Please check the documentation at https://hyperconf.readthedocs.io/en/latest/index.html

## License

This project is licensed under the MIT License - see the LICENSE file for details.