semvec/pypi-packages huggingface dataset:
get-jakdojade 0.0.2
Jakdojade URL generator
License: MIT
Requires Python: >=3.6

# GET_jakdojade

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE)
[![Wheel Status](https://img.shields.io/pypi/wheel/get-jakdojade)](https://pypi.python.org/pypi/get-jakdojade/)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/get-jakdojade)](https://pypi.python.org/pypi/get-jakdojade/)
[![PyPI - Status](https://img.shields.io/pypi/status/get-jakdojade)](https://pypi.python.org/pypi/get-jakdojade/)
[![Latest version](https://img.shields.io/pypi/v/get-jakdojade)](https://pypi.python.org/pypi/get-jakdojade/)

Jakdojade URL generator

Based on [jakdojade documentation](https://jakdojade.pl/public/pages/api/http_get.html)

## Usage

```python
import datetime

from get_jakdojade import generate

print(generate(
    city='warszawa',
    from_name='Your home',
    from_coordinate_latitude='52.275222',
    from_coordinate_longitude='20.914578',
    to_name='My shop',
    to_coordinate_latitude='52.211184',
    to_coordinate_longitude='20.984775',
    date_time=datetime.datetime(2021, 12, 28, 9, 00),
    is_arrival=True,
))
```

You can use `date_time` exchangeable with `date` and `time` parameters for convenience.

### Search now

To search now you need to provide:

- `from_coordinate_latitude`
- `from_coordinate_longitude`
- `to_coordinate_latitude`
- `to_coordinate_latitude`
- `date_time` or (`date` and `time`)
- `prepare_search=False` this is default

When searching now, user will be directed to result page instead of search form.

### Places name

Field `from_name` and `to_name` can be anything you want if coordinates provided.

For example: dating app can use:
`from_name=You` and `to_name=Date in cinema` and point current user location and cinema nearby.

### Error handling

By default, url will be generated even if some parameters are missing. If you want to not generate URL when
configuration are insufficient (for example: you want search now but, you do not provide date_time), you can pass
`strict=True` then `InsufficientParameters` will be raised.

## Release

1. Change version in setup.py to `x.y.z.dev0` (or leave if minor version bump) and ensure changelog is up to date.
   (`Nothing changed yet.` is not ok, CI will fail)
2. Tag head of master branch with `x.y.z` without `.dev0`

**Important**: release ALWAYS is from master branch! So keep master untouched when you want to release.