https://github.com/adriens/auptitcafe-sdk
😋 SDK Python pour accéder aux menus du restaurant "Au p'tit café" - Nouméa, Nouvelle-Calédonie
https://github.com/adriens/auptitcafe-sdk
datascience menu noumea nouvelle-caledonie opendata-api pypi-package python restaurant-menu
Last synced: 28 days ago
JSON representation
😋 SDK Python pour accéder aux menus du restaurant "Au p'tit café" - Nouméa, Nouvelle-Calédonie
- Host: GitHub
- URL: https://github.com/adriens/auptitcafe-sdk
- Owner: adriens
- Created: 2023-05-07T08:58:29.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-08T23:29:27.000Z (9 months ago)
- Last Synced: 2025-02-08T09:51:13.212Z (3 months ago)
- Topics: datascience, menu, noumea, nouvelle-caledonie, opendata-api, pypi-package, python, restaurant-menu
- Language: Python
- Homepage: https://dev.to/adriens/series/23071
- Size: 927 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ❔ About
> Finally a Python package to make **getting Au p'it café's menus a piece of (cheese) cake.😅**
With this [package](https://pypi.org/project/auptitcafe/) you can:
- ✔️ Get [menus](http://auptitcafe.nc/menu/)
- ✔️ Get [takeways](http://auptitcafe.nc/a-emporter/)
... and get them as list of objects or `csv`.
👉 See it live on [Kaggle](https://www.kaggle.com/adriensales/au-p-tit-caf-pypi-package-intro) 👈
# 🔖 Social networks
- [Official website](http://auptitcafe.nc/)
- [TripAdvisor](https://www.tripadvisor.com/Restaurant_Review-g294130-d1952994-Reviews-Au_P_tit_Cafe-Noumea_Grand_Terre.html)
- [Instagram](https://www.instagram.com/auptitcafe.nc/?hl=en)
- [Facebook](https://www.facebook.com/auptitcafe.nc/)
- [Google Maps](https://goo.gl/maps/4UcxegSnxMsE8qKs8)
[](https://www.youtube.com/watch?v=iRSInif_Zwc)
# 🤓 Nerd resources
- [🐍 `pypi`](https://pypi.org/project/auptitcafe/)
- [😋 Au p'tit café (pypi package intro on Kaggle) 🚀](https://www.kaggle.com/adriensales/au-p-tit-caf-pypi-package-intro)
# 🚀 Quickstart
For the impatients, here is a quick and ready to use code snippet:
```python
# Install the package
!pip install auptitcafe --upgrade
# Make some imports
from auptitcafe.menus import Menus
import pandas as pd
# Create the main utility instance
menu_instance = Menus()
# Dump menus as a csv file
menus = 'menus.csv'
menu_instance.to_csv(menus)
# Load menus in a panda dataframe
df = pd.read_csv(menus)
# Diplay dataframe
df
```
# Build it
```shell
poetry show --tree
```
```shell
poetry build
poetry install
```
## test
```shell
poetry run pytest
```
## Publish
```shell
poetry config pypi-token.pypi $PYPI_TOKEN
poetry publish
```