Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/jakubnowicki/track

Last synced: 6 days ago
JSON representation

Host: GitHub
URL: https://github.com/jakubnowicki/track
Owner: jakubnowicki
License: other
Created: 2022-06-16T14:19:37.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-06-19T10:28:25.000Z (over 2 years ago)
Last Synced: 2024-11-12T03:53:14.809Z (about 2 months ago)
Language: Python
Size: 12.7 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

# Tracks time.

## Installation

```
$ pip install -r requirements.txt

$ python setup.py install
```

## Development

This project includes a number of helpers in the `Makefile` to streamline common development tasks.

### Environment Setup

The following demonstrates setting up and working with a development environment:

```
### create a virtualenv for development

$ make virtualenv

$ source env/bin/activate

### run track cli application

$ track --help

### run pytest / coverage

$ make test
```

### Releasing to PyPi

Before releasing to PyPi, you must configure your login credentials:

**~/.pypirc**:

```
[pypi]
username = YOUR_USERNAME
password = YOUR_PASSWORD
```

Then use the included helper function via the `Makefile`:

```
$ make dist

$ make dist-upload
```

## Deployments

### Docker

Included is a basic `Dockerfile` for building and distributing `Time Tracker`,
and can be built with the included `make` helper:

```
$ make docker

$ docker run -it track --help
```