Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/fearless-spider/kreator-cli

Last synced: 14 days ago
JSON representation

Host: GitHub
URL: https://github.com/fearless-spider/kreator-cli
Owner: fearless-spider
License: bsd-3-clause
Created: 2021-02-21T11:29:16.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2021-09-02T12:50:59.000Z (about 3 years ago)
Last Synced: 2024-10-04T21:55:33.408Z (about 1 month ago)
Language: Python
Size: 14.6 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

# Create python project from command line

## Installation

```
$ pip install -r requirements.txt

$ pip install setup.py
```

## 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 kreator cli application

$ kreator --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 `Kreator CLI`,
and can be built with the included `make` helper:

```
$ make docker

$ docker run -it kreator --help
```