Metadata-Version: 2.1
Name: transx2gtfs
Version: 0.3.2
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 
        [![build status](https://travis-ci.com/HTenkanen/transx2gtfs.svg?branch=master)](https://travis-ci.com/HTenkanen/transx2gtfs)
        
        This is a small library to convert transit data from TransXchange format into 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. 
        Requires more testing. 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.
         - Combines multiple TransXchange files into a single GTFS feed if present in the same folder.
         - Uses multiprocessing to parallelize the conversion process.
         - Parses dates of non-operation (bank holidays etc.) which are written to calendar_dates.txt.
         - Uses NaPTAN stops.  
        
        ## 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.  
        
        ## Basic usage
        
        After you have installed the library you can use it in a similar manner as any Python
        library:
        
        ```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)
        ```
        
        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:
        
         - *TODO: Add Zenodo*
        
        ## 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
