https://github.com/aaditkamat/calendar
A CLI utility acting as a substitute for the Calendar GUI. Created with Typer
https://github.com/aaditkamat/calendar
calendar cli python3 typer
Last synced: 8 days ago
JSON representation
A CLI utility acting as a substitute for the Calendar GUI. Created with Typer
- Host: GitHub
- URL: https://github.com/aaditkamat/calendar
- Owner: aaditkamat
- License: mit
- Created: 2020-10-15T07:56:25.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-08T02:53:03.000Z (over 1 year ago)
- Last Synced: 2024-08-03T09:03:51.788Z (10 months ago)
- Topics: calendar, cli, python3, typer
- Language: Python
- Homepage:
- Size: 483 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Calendar 📅
As a developer, have you ever wanted to look up what day of the week a particular day falls on or find
the duration between two dates right from your terminal? Well, wait no more because this CLI utility
provides you with just that!
## Setup
1. Fork this repository and clone it.
2. Install Python 3.8+ from the [official website](https://www.python.org/downloads/)
3. Install [Poetry](https://python-poetry.org/docs/):
- MacOS / Linux / Bash on Windows:
```bash
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
```
- Powershell:
```powershell
(Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python -
```
4. [Configure Poetry](https://python-poetry.org/docs/configuration/) to allow creation of a Python virtual environment within the project root:
```bash
poetry config virtualenvs.in-project true
```
5. Install the required dependencies through Poetry:
```bash
poetry install
```
6. Activate the virtual environment through the `activate` command:
- MacOS/Linux:
```bash
source .venv/bin/activate
```
- Powershell:
```powershell
.venv\Scripts\Activate.ps1
```
> NOTE: To find out more about Python virtual environment, you can refer to the [`venv` documentation](https://docs.python.org/3/library/venv.html)
7. Execute the `main.py` Python script to see all the CLI options:
```bash
python main.py
```
## Commands
## Credits
1. This CLI utility has been bootstrapped with [@tiangolo's Typer](https://github.com/tiangolo/typer)
2. Emojis from [emojis.wiki](https://emojis.wiki/monday/)