opentraveldata 0.0.8.post3

Simple Python wrapper for OpenTravelata (OPTD)

OpenTravelData (OPTD) Data Wrapper - Python Bindings

Python wrapper around OpenTravelData (OPTD) data sets, for instance to be used by Python software needing to access OPTD data.

References

• PyPi artifacts: https://pypi.org/project/opentraveldata/
• OpenTravelData (OPTD):
  • Source code on GitHub: https://github.com/opentraveldata/opentraveldata
  • Docker Cloud repository: https://cloud.docker.com/u/opentraveldata/repository/docker/opentraveldata/quality-assurance
  • This Python-wrapper Git repository: https://github.com/opentraveldata/python-opentraveldata
• OPTD data archive:
  • POR (Points of Reference)): https://www2.transport-search.org/data/optd/por/
  • CI/CD deliveries: https://www2.transport-search.org/data/optd/cicd/
• OPTD Quality Assurance (QA):
  • Sourcce code on GitHub: https://github.com/opentraveldata/quality-assurance
  • Quality Assurance (QA) reports: https://www2.transport-search.org/data/optd/qa/

Python

• How-to install Python virtual environment with pyenv and pipenv
• How to package modules for Python
• PyPi - Deployment with Travis CI
  • PyPi Travis CI provider
  • dpl v2
  • dpl v1

Usage

• Launch a Python interpreter:

$ python

>>> 

• Import the opentraveldata library:

>>> import opentraveldata

• Specify a variable, say myOPTD, as a handle on the OPTD library:

>>> myOPTD = opentraveldata.OpenTravelData()

• Download the latest data files (to be done once in a while; it takes a few seconds, depending on the network bandwidth):

>>> myOPTD.downloadFilesIfNeeded()

• Retrieve the details for the IEV code:

>>> por = myOPTD.getServingPORList ('IEV')
>>> por
{'original': {'iata_code': 'IEV', 'location_type': 'C', 'geoname_id': 703448, 'envelope_id': '', 'name': 'Kyiv', 'country_code': 'UA', 'country_name': 'Ukraine', 'adm1_code': '12', 'adm1_name_utf': 'Kyiv City'}, 'tvl_list': [{'iata_code': 'IEV', 'location_type': 'A', 'geoname_id': 6300960, 'envelope_id': '', 'name': 'Kyiv Zhuliany International Airport', 'country_code': 'UA', 'country_name': 'Ukraine', 'adm1_code': '12', 'adm1_name_utf': 'Kyiv City'}, {'iata_code': 'KBP', 'location_type': 'A', 'geoname_id': 6300952, 'envelope_id': '', 'name': 'Kyiv Boryspil International Airport', 'country_code': 'UA', 'country_name': 'Ukraine', 'adm1_code': '13', 'adm1_name_utf': 'Kiev'}, {'iata_code': 'QOF', 'location_type': 'B', 'geoname_id': 8260936, 'envelope_id': '', 'name': 'Darnytsia Bus Station', 'country_code': 'UA', 'country_name': 'Ukraine', 'adm1_code': '13', 'adm1_name_utf': 'Kiev'}, {'iata_code': 'QOH', 'location_type': 'B', 'geoname_id': 12156352, 'envelope_id': '', 'name': 'Premier Hotel Rus Bus Stop', 'country_code': 'UA', 'country_name': 'Ukraine', 'adm1_code': '12', 'adm1_name_utf': 'Kyiv City'}]}

Installation - configuration

Python

• Reference: How-to install Python virtual environment with pyenv and pipenv: https://github.com/machine-learning-helpers/induction-python/tree/master/installation/virtual-env

• Install Pyenv, Python 3.9.5, pip and pipenv:

user@laptop$ if [ ! -d ${HOME}/.pyenv ]; then git clone https://github.com/pyenv/pyenv.git ${HOME}/.pyenv; else pushd ${HOME}/.pyenv && git pull && popd; fi
user@laptop$ cat >> ~/.bashrc << _EOF
# Python
# git clone https://github.com/pyenv/pyenv.git \${HOME}/.pyenv
export PATH="\${HOME}/.pyenv/shims:\${PATH}"
eval "\$(pyenv init -)"
eval "\$(pipenv --completion)"
 
_EOF
user@laptop$ . ~/.bashrc
user@laptop$ pyenv install 3.9.5 && pyenv global 3.9.5 && pip install -U pip pipenv && pyenv global system

• Clone the Git repository and install the Python virtual environment (with pipenv):

user@laptop$ mkdir -p ~/dev/geo && \
  git clone https://github.com/opentraveldata/python-opentraveldata.git ~/dev/geo/python-opentraveldata
user@laptop$ cd ~/dev/geo/python-opentraveldata
user@laptop$ pipenv --rm && pipenv install && pipenv install --dev
user@laptop$ python --version
Python 3.9.5

PyPi credentials for Travis deployment

• Encrypt the PyPi API token with the Travis command-line utility, which stores the encrypted secret token. As the project is managed by travis-ci.com, the --com option has to be added in the command-line:

user@laptop$ travis encrypt pypi-NotARealKey_Xo -add deploy.password --com
user@laptop$ git add .travis.yml

Package and release the Python module

• Launch the setup.py script:

user@laptop$ rm -rf dist && mkdir dist
user@laptop$ pipenv run python setup.py sdist bdist_wheel
running sdist
running egg_info
creating opentraveldata.egg-info
...
running check
creating opentraveldata-0.0.8
...
creating dist
Creating tar archive
removing 'opentraveldata-0.0.8' (and everything under it)
running bdist_wheel
...
creating build
...
installing to build/bdist.macosx-10.15-x86_64/wheel
running install
running install_lib
...
running install_egg_info
adding 'opentraveldata/__init__.py'
adding 'opentraveldata/csvwriter.py'
adding 'opentraveldata/opentraveldata.py'
adding 'opentraveldata-0.0.8.dist-info/METADATA'
adding 'opentraveldata-0.0.8.dist-info/WHEEL'
adding 'opentraveldata-0.0.8.dist-info/top_level.txt'
adding 'opentraveldata-0.0.8.dist-info/RECORD'
removing build/bdist.macosx-11.1-x86_64/wheel

user@laptop$ ls -lFh dist/
total 96
-rw-r--r--  1 user  staff  11K Mar  9 16:02 opentraveldata-0.0.8-py3-none-any.whl
-rw-r--r--  1 user  staff  32K Mar  9 16:02 opentraveldata-0.0.8.tar.gz

• Upload/release the Python packages onto the PyPi test repository:

user@laptop$ PYPIURL="https://test.pypi.org"
user@laptop$ pipenv run twine upload -u __token__ --repository-url ${PYPIURL}/legacy/ dist/*
Uploading distributions to https://test.pypi.org/legacy/
Uploading opentraveldata-0.0.8-py3-none-any.whl
100%|█████████████████████████████████████████████████████████████████████| 23.7k/23.7k [00:01<00:00, 13.5kB/s]
Uploading opentraveldata-0.0.8.tar.gz
100%|█████████████████████████████████████████████████████████████████████| 44.3k/44.3k [00:01<00:00, 41.2kB/s]

View at: https://test.pypi.org/project/opentraveldata/0.0.8/

• Upload/release the Python packages onto the PyPi repository:

user@laptop$ PYPIURL="https://pypi.org"
user@laptop$ pipenv run keyring set ${PYPIURL}/ __token__
Password for '__token__' in '${PYPIURL}/':
user@laptop$ pipenv run twine upload -u __token__ --non-interactive dist/*
Uploading distributions to https://upload.pypi.org/legacy/
Uploading opentraveldata-0.0.8-py3-none-any.whl
100%|██████████████████████████████████████████████████████████████████████| 23.7k/23.7k [00:01<00:00, 15.2kB/s]
Uploading opentraveldata-0.0.8.tar.gz
100%|██████████████████████████████████████████████████████████████████████| 44.3k/44.3k [00:01<00:00, 44.7kB/s]

View at:
https://pypi.org/project/opentraveldata/0.0.8/

Test the Python module

Pytest

• Launch the test:

$ pipenv run pytest test_optd-csvwriter.py
======================= test session starts =============================
platform darwin -- Python 3.9.5, pytest-5.3.5, py-1.8.1, pluggy-0.13.1
rootdir: ~/dev/geo/python-opentraveldata
collected 3 items                                                     

test_optd-csvwriter.py .                                           [ 33%]
test_optd-serving-por.py ..                                        [100%]

=============================== 3 passed in 2.58s =======================
_________________________________ summary _____________________________

Tox

$ pipenv run tox
.package recreate: ~/dev/geo/python-opentraveldata/.tox/.package
.package installdeps: setuptools >= 35.0.2, setuptools_scm >= 2.0.0, <3
py39 create: ~/dev/geo/python-opentraveldata/.tox/py39
py39 installdeps: pytest
py39 inst: ~/dev/geo/python-opentraveldata/.tox/.tmp/package/1/opentraveldata-0.0.8.tar.gz
py39 installed: attrs==19.3.0,certifi==2019.11.28,chardet==3.0.4,idna==2.9,more-itertools==8.2.0,opentraveldata==0.0.8,packaging==20.3,pluggy==0.13.1,py==1.8.1,pyparsing==2.4.6,pytest==5.3.5,python-dateutil==2.8.1,pytz==2019.3,requests==2.23.0,six==1.14.0,urllib3==1.25.8,wcwidth==0.1.8
py39 run-test-pre: PYTHONHASHSEED='3773488260'
py39 run-test: commands[0] | pytest
======================= test session starts =============================
platform darwin -- Python 3.9.5, pytest-5.3.5, py-1.8.1, pluggy-0.13.1
cachedir: .tox/py39/.pytest_cache
rootdir: ~/dev/geo/python-opentraveldata
collected 3 items                                                     

test_optd-csvwriter.py .                                           [ 33%]
test_optd-serving-por.py ..                                        [100%]

=============================== 3 passed in 2.58s =======================
_________________________________ summary _____________________________
  py39: commands succeeded
  congratulations :)