Metadata-Version: 2.1
Name: janky
Version: 0.1.1
Summary: null
Author: Katie McLaughlin
License: Apache-2.0
Project-URL: Homepage, https://github.com/glasnt/janky
Project-URL: Changelog, https://github.com/glasnt/janky/releases
Project-URL: Issues, https://github.com/glasnt/janky/issues
Project-URL: CI, https://github.com/glasnt/janky/actions
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: grapheme
Provides-Extra: test
Requires-Dist: pytest; extra == "test"

# janky

[![PyPI](https://img.shields.io/pypi/v/janky.svg)](https://pypi.org/project/janky/)
[![Tests](https://github.com/glasnt/janky/actions/workflows/test.yml/badge.svg)](https://github.com/glasnt/janky/actions/workflows/test.yml)
[![Changelog](https://img.shields.io/github/v/release/glasnt/janky?include_prereleases&label=changelog)](https://github.com/glasnt/janky/releases)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/glasnt/janky/blob/main/LICENSE)

null

## Installation

Install this library using `pip`:
```bash
pip install janky
```
## Usage

Usage instructions go here.

## Development

To contribute to this library, first checkout the code. Then create a new virtual environment:
```bash
cd janky
python -m venv venv
source venv/bin/activate
```
Now install the dependencies and test dependencies:
```bash
python -m pip install -e '.[test]'
```
To run the tests:
```bash
python -m pytest
```
