https://github.com/normcyr/flask_babac

A Python3 Flask front-end application to search the Cycle Babac catalogue and return description, price and availability.
https://github.com/normcyr/flask_babac

Last synced: 4 months ago
JSON representation

A Python3 Flask front-end application to search the Cycle Babac catalogue and return description, price and availability.

• Host: GitHub
• URL: https://github.com/normcyr/flask_babac
• Owner: normcyr
• License: gpl-3.0
• Created: 2020-03-14T16:52:48.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-18T21:18:41.000Z (10 months ago)
• Last Synced: 2024-09-19T14:18:26.000Z (5 months ago)
• Language: Python
• Size: 834 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

# Flask Babac

A Python3 Flask front-end application to search the Cycle Babac catalogue and return description, price and availability.

![Flask Babac logo](flask_babac/static/logo240px.png)

## Installation

1. Clone the repository

```bash

git clone https://github.com/normcyr/flask_babac

```

2. Create a Python virtual environment using `virtualenv`

```bash

cd flask_babac

virtualenv -p python3 venv

source venv/bin/activate

```

3. Install the module

```bash

pip install -e .

```

## Configuration

1. Connection to the Cycle Babac website

```bash

cp config.yml.example config.yml

```

Then edit the `config.yml` file (*eg* `nano config.yml`) and change the value of the `username` and `password` variables to the proper credentials to log in to the Cycle Babac website.

Finally, move the `config.yml` file to your user configuration folder

```bash

mkdir -p ~/.config/flask_babac

mv config.yml ~/.config/flask_babac/config.yml

```

2. Environment variables for the Flask application

```bash

cp .env.example .env

```

Then edit the `.env` file (*eg* `nano .env`) and change the values of the variables to your desired parameters.

3. Launch the Flask application

```bash

flask run

```

Then access web application at the address given, typically

[`http://127.0.0.1:8080`](http://127.0.0.1:8080)

This is the page you should get at first:

![Start screen](flask_babac/static/start_screen.png)

And after search for `training wheels`, you get your results in a table:

![Search results](flask_babac/static/search_results.png)

## Perform a search on a command line interface

Launch the search with the following command:

```bash

flask_babac search text

```

For example:

```bash

flask_babac training wheels

```

or, using a catalogue number:

```bash

flask_babac 22-150

```

## Taking advantage of the JSON endpoint

It is possible to use the JSON endpoint to search for a single SKU.

For example:

```bash

curl http://127.0.0.1:8080/json/22-168

```

which will return

```JSON

{

  "name": "Training Wheels",

  "page url": "https://cyclebabac.com/product/stabilizer-12-20/",

  "price": "10.00",

  "rebate": "False",

  "sku": "22-168",

  "stock": "Yes"

}

```