Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/tbobm/climapper

Simple tool for the Citymapper API made by a lazy person
https://github.com/tbobm/climapper

cli-toolkit command-line-tool lazy transports

Last synced: 3 days ago
JSON representation

Simple tool for the Citymapper API made by a lazy person

Host: GitHub
URL: https://github.com/tbobm/climapper
Owner: tbobm
Created: 2017-02-26T22:19:08.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-04-09T09:19:54.000Z (7 months ago)
Last Synced: 2024-04-09T10:33:54.403Z (7 months ago)
Topics: cli-toolkit, command-line-tool, lazy, transports
Language: Python
Homepage:
Size: 53.7 KB
Stars: 3
Watchers: 4
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Climapper

 ![Citymapper](https://lh6.ggpht.com/Imb9kzIzJPanYvoMhRzT04AemnqlYzS2RmU4rHX-Hoy3WONLzRhUo3j9bIJJi1N7we8F=w300)

 

[![Build Status](https://travis-ci.org/massard-t/climapper.svg?branch=master)](https://travis-ci.org/massard-t/climapper) [![Coverage Status](https://coveralls.io/repos/github/massard-t/climapper/badge.svg?branch=master)](https://coveralls.io/github/massard-t/climapper?branch=master)

Simple tool that for the Citymapper API made by a lazy person.

This project isn't related to Citymapper in any way, totally unofficial.

## Installation

### Prerequisites

#### Dependencies

Climapper works perfectly under python3. It uses 2 pip3 packages, `Unidecode` and `requests`.

```bash

sudo -H pip3 install -r requirements.txt

```

#### Installation

Simply run the installation script. It will create a `~/bin` directory, and a symbolic link to your climapper script.

This configuration allows you to update the script without having to run the installation script again.

```bash

./install

```

#### Configuration

In order to get climapper to work efficiently, you have to set a `home` variable, based on the LAT and LONG of your destination.

> Example:

```bash

# In your bash_profile (or bashrc)

export WORK="48.813896,2.392448"

export MY_HOME="48.928378,2.162200"

```

## Usage

```bash

$ climapper home

--------------------------------

| Rer C        |     5 min     |

|------------------------------|

| Bibliotheque Francois Mitt   |

|------------------------------|

| Rer A        |     19 min    |

|------------------------------|

|..............................|

|      Home in 89 min          |

|------------------------------|

```

## Todos

- [x] Collect destination and current location (ENV variables ?)

- [x] Make a call to the API

- [x] Parse the results

- [x] Display them gracefully

- [ ] Manage CLI args

- [ ] Manage configuration trough specific file (~/.config/climapper.json?)

- [ ] Create a clean wrapper for the API

### Resources

[Citymapper Website](https://citymapper.com/)

[Citymapper for Directions](https://citymapper.com/tools/1053/launch-citymapper-for-directions)

[Citymapper for Robots](https://citymapper.3scale.net/docs)

[latlon.net](http://www.latlong.net/)