Skip to content

Commit

Permalink
Visual improvements. Updated project info.
Browse files Browse the repository at this point in the history
  • Loading branch information
kotano committed Aug 4, 2020
1 parent c3c0671 commit 08e4bee
Show file tree
Hide file tree
Showing 9 changed files with 171 additions and 92 deletions.
61 changes: 40 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,43 +2,57 @@

<img alt="Tempo icon" align="right" height="256" src="https://kotano.github.io/Tempo/data/icons/logo.png"/>

Tempo is a task-management application that tracks your tasks / goals and evenly distributes work on them.
Tempo is a task-management application that tracks your tasks / goals and evenly distributes work on them.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
See deployment for notes on how to deploy the project on a live system.


### Prerequisites

You can create development environment using anaconda __environment.yml__ file in the Tempo repository __data__ folder.
To do this after downloading Tempo repository enter following commands into [__Anaconda Prompt__](https://docs.conda.io/projects/conda/en/latest/user-guide/install/#regular-installation) :

```
```sh
cd path/to/repo/data
conda update --all
conda env create -f environment.yml
```

OR

Install via poetry. Inside repo directory type:

```sh
pip install poetry

poetry install
```

This gonna fully set up your development environment.

#### Kivy

To start working on project you first need to download [__kivy__](https://github.com/kivy/kivy) framework.

The simpliest way to do this is to use Anaconda.
>Install Kivy using Anaconda:
>Using your Anaconda virtual environment type following command into the console.
>```
>conda install kivy -c conda-forge
>```
Install Kivy using Anaconda:
Using your Anaconda virtual environment type following command into the console.

```sh
conda install kivy -c conda-forge
```

For other installation options, please refer to [kivy download page](https://kivy.org/#download).

#### Plyer
Plyer is used to work with OS features like notifications or vibration.
$ pip install plyer

Plyer is used to work with OS features like notifications or vibration.

```sh
pip install plyer
```

### Installing

Expand All @@ -48,18 +62,20 @@ The installation of Tempo is pretty simple, and it doesn`t require any additiona

Step 1: Clone Tempo repository from GitHub

```
```sh
git clone https://github.com/kotano/Tempo.git
```

Step 2: Running the app

Make sure you have installed kivy and other dependencies before launch.

```
```sh
python .../Tempo/main.py
```

After executing this command, you will see the main application window.

<img alt="Main application window" align="" height="" src="https://kotano.github.io/Tempo/data/examples/task_window.png"/>

## Running the tests
Expand All @@ -68,23 +84,27 @@ For this project we use PyTest to automatically test our systems.

### Running tests

```
```sh
make test
```
or
```

or

```sh
projectdir$ pytest
```
```

### And coding style tests

We use flake8 for code linting

```
```sh
make lint
```

or
```

```sh
projectdir$ flake8
```

Expand All @@ -93,7 +113,6 @@ projectdir$ flake8
* [kivy](https://kivy.org) - GUI framework
* [plyer](https://github.com/kivy/plyer) - platform-independent Python wrapper for platform-dependent APIs

## Team

* **Arslan Hudaygulyyev** - *Main developer* - [kotano](https://github.com/kotano)
Expand Down
Binary file added data/icons/logo_dark.ico
Binary file not shown.
Binary file added data/icons/logo_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added data/icons/logo_dark_50.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 08e4bee

Please sign in to comment.