add cli app and fix relationship typos

This commit is contained in:
Thomas Peetz
2025-01-13 22:54:25 +01:00
committed by Thomas Peetz
parent 89b7b87b8c
commit 54bc17ee7d
54 changed files with 1138 additions and 5 deletions
+69
View File
@@ -0,0 +1,69 @@
# Kontor CLI Tool
## 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 kontor cli application
$ kontor --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 `Kontor`,
and can be built with the included `make` helper:
```
$ make docker
$ docker run -it kontor --help
```