Metadata-Version: 2.1
Name: transx2gtfs
Version: 0.4.0
Summary: A Python tool to convert TransXchange data into GTFS.
Home-page: https://github.com/htenkanen/transx2gtfs
Author: Henrikki Tenkanen
Author-email: h.tenkanen@ucl.ac.uk
License: MIT
Description: # transx2gtfs 
        [![PyPI version](https://badge.fury.io/py/transx2gtfs.svg)](https://badge.fury.io/py/transx2gtfs) [![build status](https://travis-ci.com/HTenkanen/transx2gtfs.svg?branch=master)](https://travis-ci.com/HTenkanen/transx2gtfs) [![Coverage Status](https://codecov.io/gh/HTenkanen/transx2gtfs/branch/master/graph/badge.svg)](https://codecov.io/gh/HTenkanen/transx2gtfs) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3631477.svg)](https://doi.org/10.5281/zenodo.3631477) [![Gitter](https://badges.gitter.im/transx2gtfs/community.svg)](https://gitter.im/transx2gtfs/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
        
        **transx2gtfs** is a library for converting public transport data from [TransXchange](https://www.gov.uk/government/collections/transxchange) -format 
        (data standard in UK) into a widely used [GTFS](https://developers.google.com/transit/gtfs) -format that can be used with 
        various routing engines such as OpenTripPlanner. 
        
        ## Note!
        
        This package is still in a Beta-phase, so use it at your own risk. 
        If you find an issue, you can contribute and 
        help solving them by [raising an issue](https://github.com/HTenkanen/transx2gtfs/issues).
        
        ## Features
        
         - Reads TransXchange xml-files and converts into GTFS feed with all necessary information 
         according the General Transit Feed Specification.
         - Works and tested against different TransXchange schemas (TfL schema and TXC 2.1)
         - Combines multiple TransXchange files into a single GTFS feed if present in the same folder.
         - Finds and reads all XML files present in ZipFiles, nested ZipFiles and unpacked directories. 
         - Uses multiprocessing to parallelize the conversion process.
         - Parses bank holidays (from [gov.uk](https://www.gov.uk/bank-holidays)) affecting transit operations at the given time span of the TransXChange feed, which are written to calendar_dates.txt.
         - Reads and updates stop information automatically from NaPTAN website.  
         
        ## Why yet another converter?
        
        There are numerous TransXChange to GTFS converters written in different programming languages. 
        However, after testing many of them, it was hard to find a tool that would:
        
         1. work in general (without ad-hoc modifications)
         2. parse all important information from the TransXChange according GTFS specification.
         3. work with different TransXChange schema versions
         4. be well maintained
         5. be easy to use in all operating systems
         6. include appropriate tests (crucial for maintenance).
         
        Hence, this Python package was written which aims at meeting the aforementioned requirements. 
        It's not the fastest library out there (written in Python) but multiprocessing gives a bit of boost
        if having a decent computer with multiple cores.
        
        ## Install
        
        The package is available at PyPi and you can install it with:
        
        `$ pip install transx2gtfs`
        
        Library works and is being tested with Python versions 3.6, 3.7 and 3.8.  
        
        If you don't know how to install Python, you can take a look for example [these materials](https://geo-python.github.io/site/course-info/installing-anacondas.html).
        
        ### Requirements
        
        transx2gtfs has following dependencies (tested against the latest versions available for Python 3.6, 3.7 and 3.8):
        
         - untangle
         - pandas
         - pyproj
          
        ## Basic usage
        
        After you have installed the library you can use it in a following manner:
        
        ```python
        >>> import transx2gtfs
        >>> data_dir_for_transxchange_files = "data/my_transxchange_files"
        >>> output_path = "data/my_converted_gtfs.zip"
        >>> transx2gtfs.convert(data_dir_for_transxchange_files, output_path)
        ```
        
        There are a few parameters that you can adjust:
        
        ```
        input_filepath : str
            File path to data directory or a ZipFile containing one or multiple TransXchange .xml files.
            Also nested ZipFiles are supported (i.e. a ZipFile with ZipFile(s) containing .xml files.)
        
        output_filepath : str
            Full filepath to the output GTFS zip-file, e.g. '/home/myuser/data/my_gtfs.zip'
        
        append_to_existing : bool (default is False)
            Flag for appending to existing gtfs-database. This might be useful if you have
            TransXchange .xml files distributed into multiple directories (e.g. separate files for
            train data, tube data and bus data) and you want to merge all those datasets into a single
            GTFS feed.
        
        worker_cnt : int
            Number of workers to distribute the conversion process. By default the number of CPUs is used.
        
        file_size_limit : int
            File size limit (in megabytes) can be used to skip larger-than-memory XML-files (should not happen).
        ```
        
        ## Output
        
        After you have successfully converted the TransXchange into GTFS, you can start doing
        multimodal routing with your favourite routing engine such as OpenTripPlanner:
        
        ![OTP_example_in_London](img/London_multimodal_route.PNG)
        
        ## Citation
        
        If you use this tool for research purposes, we encourage you to cite this work:
        
         - Henrikki Tenkanen. (2020). transx2gtfs (Version v0.3.5). Zenodo. http://doi.org/10.5281/zenodo.3631477
        
        ## Developers
        
        - Henrikki Tenkanen, University College London
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Utilities
Requires-Python: >=3, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, <3.9
Description-Content-Type: text/markdown
