Metadata-Version: 2.1
Name: kdict
Version: 0.0.1
Summary: Kdict
Home-page: https://github.com/maximz/kdict
Author: Maxim Zaslavsky
Author-email: maxim@maximz.com
License: MIT license
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Kdict

[![](https://img.shields.io/pypi/v/kdict.svg)](https://pypi.python.org/pypi/kdict)
[![CI](https://github.com/maximz/kdict/actions/workflows/ci.yaml/badge.svg?branch=master)](https://github.com/maximz/kdict/actions/workflows/ci.yaml)
[![](https://img.shields.io/badge/docs-here-blue.svg)](https://kdict.maximz.com)
[![](https://img.shields.io/github/stars/maximz/kdict?style=social)](https://github.com/maximz/kdict)

## TODOs: Configuring this template

Create a Netlify site for your repository, then turn off automatic builds in Netlify settings.

Add these CI secrets: `PYPI_API_TOKEN`, `NETLIFY_AUTH_TOKEN` (Netlify user settings - personal access tokens), `DEV_NETLIFY_SITE_ID`, `PROD_NETLIFY_SITE_ID` (API ID from Netlify site settings)

## Overview

## Installation

```bash
pip install kdict
```

## Usage

## Development

Submit PRs against `develop` branch, then make a release pull request to `master`.

```bash
# Install requirements
pip install --upgrade pip wheel
pip install -r requirements_dev.txt

# Install local package
pip install -e .

# Install pre-commit
pre-commit install

# Run tests
make test

# Run lint
make lint

# bump version before submitting a PR against master (all master commits are deployed)
bump2version patch # possible: major / minor / patch

# also ensure CHANGELOG.md updated
```


# Changelog

## 0.0.1

* First release on PyPI.


