semvec/pypi-packages huggingface dataset:
flight_arbitrage 1.0.0
Finds arbitrage in plane ticket prices
Requires Python: >=3.7

## Flight Arbtrage

[![PyPI Version][pypi-image]][pypi-url]
[![Build Status][build-image]][build-url]
[![Documentation Status][doc-image]][doc-url]
[![Code Coverage][coverage-image]][coverage-url]
[![Code Quality][quality-image]][quality-url]
[![PyPI - Python Version][version-image]][pypi-url]


<!-- Badges -->

[pypi-image]: https://img.shields.io/pypi/v/flight_arbitrage
[pypi-url]: https://pypi.org/project/flight_arbitrage/
[build-image]: https://github.com/jrinder42/Flight_Arbitrage/actions/workflows/build.yml/badge.svg
[build-url]: https://github.com/jrinder42/Flight_Arbitrage/actions/workflows/build.yml
[doc-image]: https://readthedocs.org/projects/flight-arbitrage/badge/?version=latest
[doc-url]: https://flight-arbitrage.readthedocs.io/en/latest/
[coverage-image]: https://codecov.io/gh/jrinder42/Flight_Arbitrage/branch/main/graph/badge.svg
[coverage-url]: https://codecov.io/gh/jrinder42/Flight_Arbitrage
[quality-image]: https://api.codeclimate.com/v1/badges/85937031d4258ed2909a/maintainability
[quality-url]: https://codeclimate.com/github/jrinder42/Flight_Arbitrage
[version-image]: https://img.shields.io/pypi/pyversions/flight_arbitrage

This project adheres to [Semantic Versioning](https://semver.org/)

### Install
```bash
pip install flight_arbitrage
```

### Features

- Parse plane tickets for arbitrage opportunities

- Scrape websites in a headless browser mode

### Examples

Common 

```python
from flight_arbitrage.hidden_city import OneWay

arbitrage = OneWay('JFK', 'SLC', '07/10/2021')
a = arbitrage.find_arbitrage(headless=True)
print(f'Is there an arbitrage opportunity: {len(a) > 0}')
for d in a:
    print(d)
```

Change airport list to search

```python
from flight_arbitrage.hidden_city import OneWay

arbitrage = OneWay('JFK', 'SLC', '07/10/2021')
a = arbitrage.find_arbitrage(headless=True, 
                             override=True,
                             override_filename='custom_list.txt')
print(f'Is there an arbitrage opportunity: {len(a) > 0}')
for d in a:
    print(d)
```

### License

Flight Arbitrage is MIT licensed, as found in the LICENSE file.

### Notes

- You may have to play around with getting `selenium` to work