starlette-admin-fields 0.1.0
Extra fields to use with Starlette Admin
Requires Python: >=3.8
Keywords: admin,ckeditor4,ckeditor5,dashboard,fastapi,fields,jinja2,simplemde,starlette,starlette-admin,template

# starlette-admin-fields

[![CI](https://github.com/hasansezertasan/starlette-admin-fields/actions/workflows/ci.yml/badge.svg)](https://github.com/hasansezertasan/starlette-admin-fields/actions?query=event%3Apush+branch%3Amain+workflow%3ACI)
[![PyPI - Version](https://img.shields.io/pypi/v/starlette-admin-fields.svg)](https://pypi.org/project/starlette-admin-fields)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/starlette-admin-fields.svg)](https://pypi.org/project/starlette-admin-fields)
[![License](https://img.shields.io/github/license/hasansezertasan/starlette-admin-fields.svg)](https://github.com/hasansezertasan/starlette-admin-fields/blob/main/LICENSE)
[![Latest Commit](https://img.shields.io/github/last-commit/hasansezertasan/starlette-admin-fields)](https://github.com/hasansezertasan/starlette-admin-fields)

[![Downloads](https://pepy.tech/badge/starlette-admin-fields)](https://pepy.tech/project/starlette-admin-fields)
[![Downloads/Month](https://pepy.tech/badge/starlette-admin-fields/month)](https://pepy.tech/project/starlette-admin-fields)
[![Downloads/Week](https://pepy.tech/badge/starlette-admin-fields/week)](https://pepy.tech/project/starlette-admin-fields)

Extra fields to use with Starlette Admin

-----

**Table of Contents**

- [starlette-admin-fields](#starlette-admin-fields)
  - [Features](#features)
    - [Fields](#fields)
  - [Installation](#installation)
  - [Usage](#usage)
  - [Motivation](#motivation)
  - [Author](#author)
  - [License](#license)

## Features

- Quick integration with Starlette Admin
- Zero dependencies
- Fully typed

### Fields

| Field                                                                        | Name                         |
| ---------------------------------------------------------------------------- | ---------------------------- |
| [Bootstrap Show Password](https://bootstrap-show-password.wenzhixin.net.cn/) | `BootstrapShowPasswordField` |
| [CKEditor4](https://ckeditor.com/)                                           | `CKEditor4Field`             |
| [CKEditor5](https://ckeditor.com/)                                           | `CKEditor5Field`             |
| [SimpleMDE](https://simplemde.com/)                                          | `SimpleMDEField`             |

## Installation

> Latest Release

```console
pip install starlette-admin-fields
```

> Development Version

```console
pip install git+https://github.com/hasansezertasan/starlette-admin-fields.git
```

## Usage

I didn't write the documentation yet but it's pretty straightforward. You can check the [example](https://github.com/hasansezertasan/starlette-admin-fields/tree/main/example) directory for usage.

## Motivation

I implemented these fields for my own projects and decided to share them.

## Author

- [Hasan Sezer Tasan](https://www.github.com/hasansezertasan), It's me :wave:

## License

`starlette-admin-fields` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.