Skip to content

radhill7k/phinisid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

phinisid

A Desktop Phinisi App


This Kivy app was generated with Cookiecutter along with @hackebrot's Cookiedozer template.

Features

  • Minimal design with flat colors
  • Text labels that contain clickable links
  • Several slides that can be controlled via swipe gestures
  • Settings panel to change the slider transition delay (<F1>)

Requirements

To run "phinisid" you only need Kivy.

Depending on the features that you want to use, you do require additional libs though.

  • pytest - implement readable tests without boilerplate-code
  • pytest-cov - generate an html coverage report
  • Sphinx - generate a readable html documentation
  • Buildozer - deploy your app to an Android mobile device

Installation

Clone the repository:

$ git clone https://github.com/radhill7k/phinisid.git
$ cd phinisid

Create a new virtual environment. Given that you are using virtualenvwrapper:

$ mkvirtualenv -a $(pwd) --system-site-packages phinisid

Note

If you prefer to set up a fresh env, feel free to omit the according option. Chances are that you want to use your systems Kivy including all its dependencies such as Cython.

Install the app package in "editable" mode:

$ python setup.py develop

Usage

Launch the app via:

$ phinisid

Run the pytest test suite:

$ make test

Generate an html coverage report and open it:

$ make coverage

Generate Sphinx html documentation and open it:

$ make docs

Build an android apk with Buildozer:

$ make apk

Deploy the app to your android device with Buildozer:

$ make deploy

License

Distributed under the terms of the MIT license, "phinisid" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors