https://github.com/georgysk/teashop
Retrieves information from the Tea Shop website.
https://github.com/georgysk/teashop
Last synced: 4 months ago
JSON representation
Retrieves information from the Tea Shop website.
- Host: GitHub
- URL: https://github.com/georgysk/teashop
- Owner: GeorgySk
- License: mit
- Created: 2023-04-16T14:09:26.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-06T17:14:31.000Z (about 1 year ago)
- Last Synced: 2025-01-03T02:27:11.124Z (6 months ago)
- Language: Python
- Homepage:
- Size: 242 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TeaShop
===
[](https://github.com/GeorgySk/teashop/actions/workflows/ci.yml "Github Actions")
[](https://codecov.io/gh/GeorgySk/teashop "Codecov")
[](https://teashop.readthedocs.io/en/latest "Documentation")
[](https://github.com/GeorgySk/teashop/blob/master/LICENSE "License")
[](https://badge.fury.io/py/teashop "PyPI")
Summary
-------
Retrieves information from the Tea Shop website.
---
In what follows `python` is an alias for `python3.8` or any later
version.
Installation
------------
Install the latest `pip` & `setuptools` packages versions
```bash
python -m pip install --upgrade pip setuptools
```
### User
Download and install the latest stable version from `PyPI` repository
```bash
python -m pip install --upgrade teashop
```
### Developer
Download the latest version from `GitHub` repository
```bash
git clone https://github.com/GeorgySk/teashop.git
cd gon
```
Install dependencies
```bash
poetry install
```
Usage
-----
```python
from teashop import fetch_teas
teas = fetch_teas()
assert isinstance(teas, dict)
```
Development
-----------
### Bumping version
#### Preparation
Install
[bump-my-version](https://github.com/callowayproject/bump-my-version/tree/master?tab=readme-ov-file#installation).
#### Pre-release
Choose which version number category to bump following [semver
specification](http://semver.org/).
Test bumping version
```bash
bump-my-version bump --dry-run --verbose $CATEGORY
```
where `$CATEGORY` is the target version number category name, possible
values are `patch`/`minor`/`major`.
Bump version
```bash
bump-my-version bump --verbose $CATEGORY
```
This will set version to `major.minor.patch-alpha`.
#### Release
Test bumping version
```bash
bump-my-version bump --dry-run --verbose release
```
Bump version
```bash
bump-my-version bump --verbose release
```
This will set version to `major.minor.patch`.
### Running tests
Plain:
```bash
pytest
```
Inside `Docker` container:
```bash
docker-compose run --entrypoint pytest teashop
```