Metadata-Version: 2.1
Name: krmd
Version: 0.0.1.dev20220320211225
Summary: Simple command reminder application
Home-page: https://github.com/keremdemirtrk/krmd
Author: Kerem Demirturk
Author-email: keremdemirtrk@gmail.com
License: unlicensed
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE.md

# Simple command reminder application

## Installation

```
$ pip install -r requirements.txt

$ python setup.py install
```

## Development

This project includes a number of helpers in the `Makefile` to streamline common development tasks.

### Environment Setup

The following demonstrates setting up and working with a development environment:

```
### create a virtualenv for development

$ make virtualenv

$ source env/bin/activate


### run krmd cli application

$ krmd --help


### run pytest / coverage

$ make test
```


### Releasing to PyPi

Before releasing to PyPi, you must configure your login credentials:

**~/.pypirc**:

```
[pypi]
username = YOUR_USERNAME
password = YOUR_PASSWORD
```

Then use the included helper function via the `Makefile`:

```
$ make dist

$ make dist-upload
```

## Deployments

### Docker

Included is a basic `Dockerfile` for building and distributing `Your local command reminder`,
and can be built with the included `make` helper:

```
$ make docker

$ docker run -it krmd --help
```


