Skip to content

Commit

Permalink
Updating to install from PyPi
Browse files Browse the repository at this point in the history
  • Loading branch information
anufrievroman committed Jan 14, 2022
1 parent 9f61e6c commit 86a0a45
Show file tree
Hide file tree
Showing 5 changed files with 255 additions and 160 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Roman Anufriev

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
32 changes: 20 additions & 12 deletions readme.md → README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Calcure

Minimalist TUI calendar and task manager with customizable interface. Manages your events and tasks, displays birthdays from your [abook](https://abook.sourceforge.io/), and can import events and tasks from [calcurse](https://github.com/lfos/calcurse).
Modern TUI calendar and task manager with customizable interface. Manages your events and tasks, displays birthdays from your [abook](https://abook.sourceforge.io/), and can import events and tasks from [calcurse](https://github.com/lfos/calcurse) and [taskwarrior](https://github.com/GothenburgBitFactory/taskwarrior).

![screenshot](screen.jpg)

Expand All @@ -22,29 +22,37 @@ Minimalist TUI calendar and task manager with customizable interface. Manages yo

## Installation

### On Arch Linux, Manjaro, Artix and other arch-based distributions
`pip install calcure`

The package `calcure` is available in AUR. Install it with `yay -S calcure` or with another AUR helper.

### On other Linux distributions
### On Arch Linux, Manjaro etc

Just copy the `calcure` file into a directory with your binaries and make it executable. For example,:
The package `calcure` is available in AUR.

`yay -S calcure`

```
git clone https://github.com/anufrievroman/calcure
cp calcure/calcure $HOME/.local/bin
chmod =rwx $HOME/.local/bin/calcure
pip install holidays
```

### On Windows

1. Install `Windows Terminal` app from the app store
2. Install `python 3.x` also from the app store (if you just type `python` in the Windows Terminal app it will offer you to install)
3. Install a few libraries by typing in the Windows Terminal `pip install holidays windows-curses`
4. Download this repository and extract the `calcure` file somewhere, for this example we'll use `Documents` folder.
4. Download this repository and extract the `calcure.py` file somewhere, for this example we'll use `Documents` folder.
5. Now you can finally run it by typing in the Windows Terminal `python $HOME\Documents\calcure` (you can set up a shortcut for this command)


### Manual installation

Just copy the `calcure.py` file into a directory with your binaries, rename into `calcure` and make it executable. For example,:

```
git clone https://github.com/anufrievroman/calcure
cp calcure/calcure.py calcure/calcure
cp calcure/calcure $HOME/.local/bin
chmod =rwx $HOME/.local/bin/calcure
pip install holidays
```

## Dependencies

To run, it only requires python 3. On Linux and MacOS, you should have it by default, but if you don't, install `python` package from your standard repository.
Expand Down
Loading

0 comments on commit 86a0a45

Please sign in to comment.