Skip to content

Commit

Permalink
renamed master branch to main
Browse files Browse the repository at this point in the history
  • Loading branch information
Kamik423 committed Sep 18, 2022
1 parent b0b4f19 commit 3e78aae
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
12 changes: 6 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

*Command line User Tools for Input Easification*

[![Build Status](https://travis-ci.org/Kamik423/cutie.svg?branch=master)](https://travis-ci.org/Kamik423/cutie)
[![Build Status](https://travis-ci.org/Kamik423/cutie.svg?branch=main)](https://travis-ci.org/Kamik423/cutie)
[![Coverage Status](https://coveralls.io/repos/github/Kamik423/cutie/badge.svg?branch=coveralls_integration)](https://coveralls.io/github/Kamik423/cutie?branch=coveralls_integration)
[![PRs Welcome](https://img.shields.io/badge/Homepage-GitHub-green.svg)](https://github.com/kamik423/cutie)
[![PyPI version](https://badge.fury.io/py/cutie.svg)](https://badge.fury.io/py/cutie)
Expand All @@ -20,12 +20,12 @@ It will only return once the user inputs a number in that format, showing a warn

It should work on all major operating systems (Mac, Linux, Windows).

![example](https://github.com/Kamik423/cutie/blob/master/example.gif?raw=true)
![example](https://github.com/Kamik423/cutie/blob/main/example.gif?raw=true)

## Usage

These are the main functions of cutie.
[example.py](https://github.com/Kamik423/cutie/blob/master/example.py) contains an extended version of this also showing off the `select_multiple` option.
[example.py](https://github.com/Kamik423/cutie/blob/main/example.py) contains an extended version of this also showing off the `select_multiple` option.

```python
import cutie
Expand Down Expand Up @@ -91,7 +91,7 @@ pip3 install -r requirements.txt
## Documentation

All functions of cutie are explained here.
If something is still unclear or you have questions about the implementation just take a look at [cutie.py](https://github.com/Kamik423/cutie/blob/master/cutie.py).
If something is still unclear or you have questions about the implementation just take a look at [cutie.py](https://github.com/Kamik423/cutie/blob/main/cutie.py).
The implementation is rather straight forward.

### get\_number
Expand Down Expand Up @@ -200,7 +200,7 @@ In that case space bar and enter select a line.
The button can be hidden.
In that case space bar selects the line and enter confirms the selection.

This is not in the example in this readme, but in [example.py](https://github.com/Kamik423/cutie/blob/master/example.py).
This is not in the example in this readme, but in [example.py](https://github.com/Kamik423/cutie/blob/main/example.py).

```python
packages_to_update = cutie.select_multiple(
Expand Down Expand Up @@ -339,7 +339,7 @@ If you have a project that uses cutie please let me know and I'll link it here!

## License

The project is licensed under the [MIT-License](https://github.com/Kamik423/cutie/blob/master/license.md).
The project is licensed under the [MIT-License](https://github.com/Kamik423/cutie/blob/main/license.md).

## Acknowledgments

Expand Down
9 changes: 8 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
"""Setup module for PyPI / pip integration.
"""

import cutie
import imp

import setuptools

with open("readme.md", encoding="utf-8") as file:
LONG_DESCRIPTION = file.read()

with open("cutie.py", encoding="utf-8") as file:
# only go to first import since that module is not yet installed
CUTIE_CONTENTS = file.read().split("import")[0]

cutie = imp.new_module("cutie")
exec(CUTIE_CONTENTS, cutie.__dict__)

setuptools.setup(
name="cutie",
Expand Down

0 comments on commit 3e78aae

Please sign in to comment.