https://github.com/thiagojacinto/time-until-cli

Application that calculate time duration until reach a given date.
https://github.com/thiagojacinto/time-until-cli

cli cli-app python

Last synced: 8 days ago
JSON representation

Application that calculate time duration until reach a given date.

• Host: GitHub
• URL: https://github.com/thiagojacinto/time-until-cli
• Owner: thiagojacinto
• License: gpl-3.0
• Created: 2023-02-25T22:28:14.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-03T22:37:33.000Z (3 months ago)
• Last Synced: 2024-11-03T23:19:22.698Z (3 months ago)
• Topics: cli, cli-app, python
• Language: Python
• Homepage: https://pypi.org/project/time-until/
• Size: 126 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# time-until-cli

> Application that calculate time duration until reach a given date.

**Main objective**: Understanding the logic of _Python_ app publishing and documenting it on a simple project.

## Usage

```bash

time_until 22h

```

## Application flow & use cases

Using CLI to calculate time duration to a given input date or timestamp. 

| Input | Output / Response |

| :---- | :---------------- |

| `time-until 23h` | Time remaining: 8 hour(s) 22 minute(s) 42 second(s) |

| `time-until 2023-02-27` | Time remaining: 04 month(s) 14 day(s) 8 hour(s) 22 minute(s) 42 second(s)  |

![app-flow-example](assets/time_until_app.png)

## Main goals

Build a Python app that works as a CLI (Command-line Interface) that receives a future date or time and returns a calculation of remaining time from now until that given date or time.

Once working, this project must be configured and submitted as Python package thru PyPI Modules. The process of development, build, release and publishing is the core of the project, to understand it and provice ideas and thoghts of process automation.

Feel free to initiate a discusison, open a issue or a pull request to this project. All kinds of contributions and ideas are welcome. **_Let's code!_**

## Development

A quick guide to contribute (or develop) on this project.

We recommend to [use an isolated environment](https://packaging.python.org/pt-br/latest/guides/installing-using-pip-and-virtual-environments/), then install the devolpment dependencies:

```bash

# For Unix / macOS systems

cd path/to/time-until # substitute with the real path to this project directory

# Activate Python enviroment

python3 -m venv .venv

source .venv/bin/activate

# Install development dependencies

pip install -r requirements-development.txt 

```

### Testing

With development dependencies installed, you can execute tests with *pytest*:

```bash

# Run tests

pytest

```

### Packaging

Create a package of this project with `wheel`:

```bash

# Build

python3 -m build --wheel

```