Metadata-Version: 2.1
Name: transporthours
Version: 0.0.4
Summary: Package for handling public transport routes opening hours from OpenStreetMap
Home-page: https://github.com/Jungle-Bus/transport-hours-py
Author: Adrien Pavie & Jungle Bus
Author-email: panieravide@riseup.net
License: GNU LGPLv3
Description: # Transport Hours (Python version)
        
        ## Read-me
        
        TransportHours is a Python (2.7+) library for easy reading/writing of [public transport hours](https://wiki.openstreetmap.org/wiki/Key:interval) present in OpenStreetMap. It interprets string values from OSM tags, and also converts your objects into string values to go back into OSM.
        
        
        ## Install
        
        ### From pip
        
        Just run the following command in your development environment :
        
        ```bash
        pip install transporthours
        ```
        
        ### Using this repository
        
        Download this repository, then embed the library into your own project :
        
        ```python
        from transporthours.main import Main
        ```
        
        
        ## Usage
        
        An example of usage is available in [example.py](example.py) file.
        
        For more details about available functions, see [API documentation](API.md).
        
        
        ## Build & develop
        
        For start developing on this library, run the following commands :
        
        ```bash
        # Prepare python 2.7 environment
        virtualenv env -p /usr/bin/python2.7
        source ./env/bin/activate
        
        # Install dependencies
        make deps
        
        # Run unit tests
        make test
        
        # Generate documentation
        make docs
        
        
        # Following commands are optional, but can be useful sometimes
        
        # Run a single unit test
        python tests/test_main.py MainTest.test_name_of_the_test
        ```
        
        ### Publish on PyPI
        
        ```bash
        # Put your credentials in .pypirc (only first time you want to publish)
        vim ~/.pypirc
        
        # Install Twine (only first time you want to publish)
        pip install twine
        
        # Be sure to have updated package version number
        vim setup.py
        
        # Build archives
        python setup.py sdist bdist_wheel
        
        # Check builds
        twine check dist/*
        
        # Test upload on TestPyPI
        twine upload dist/* -r testpypi
        
        # Real upload on PyPI
        twine upload dist/* -r pypi
        ```
        
        
        ## License
        
        Copyright 2019 Jungle Bus & [Adrien PAVIE](https://pavie.info/)
        
        See [LICENSE](LICENSE) for complete LGPL3 license.
        
        TransportHoursPython is free software: you can redistribute it and/or modify
        it under the terms of the GNU Lesser General Public License as published by
        the Free Software Foundation, either version 3 of the License, or
        (at your option) any later version.
        
        TransportHoursPython is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU Lesser General Public License for more details.
        
        You should have received a copy of the GNU Lesser General Public License
        along with TransportHoursPython. If not, see <http://www.gnu.org/licenses/>.
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=2.7
Description-Content-Type: text/markdown
