Metadata-Version: 2.1
Name: pyturf
Version: 0.1
Summary: Python geospatial library
Home-page: https://github.com/diogomatoschaves/py-turf
Author: Diogo Matos Chaves
Author-email: di.matoschaves@gmail.com
License: MIT license
Description: # pyturf
        
        `pyturf` is loosely based on [turf.js](https://github.com/Turfjs/turf), a popular geospatial engine 
        written in javascript. It follows the same modular structure and maintains the same functionality as the original
        modules in that library. 
        
        It includes traditional geospatial operations, as well as helper functions for creating [GeoJSON](https://geojson.org/)
        data. 
        
        ## Installation
        
        `pip install pyturf`
        
        ## Usage
        
        Most `pyturf` modules expect as input GeoJSON features or a collection of these, which can be the following:
        
        - Point / MultiPoint
        - LineString / MultiLineString
        - Polygon / MultiPolygon
        
        These can either be defined as a python dictionary or as objects from `pyturf` helper classes. 
        
        ```python
        # example as a dictionary:
        
        point1 = {
          "type": "Feature",
          "properties": {},
          "geometry": {
            "type": "Point",
            # Note order: longitude, latitude.
            "coordinates": [-73.988214, 40.749128] 
          }
        }
        
        ...
        
        # Example using objects from helper classes
        
        from turf import point
        
        # Note order: longitude, latitude.
        point1 = point([-73.988214, 40.749128])
        
        ```
        
        In order to use the modules, one can import directly from `pyturf`, such as:
        
        ```python
        from turf import distance, point
        
        point1 = point([-73.988214, 40.749128])
        point2 = point([-73.838432, 40.738484])
        
        dist = distance(point1, point2, {"units": "miles"})
        ```
        
        ## Contributing
        
        This library is a work in progress, so pull requests from the community are welcome!
        
        As the library follows a modular structure, it is fairly easy to contribute by working on a subpackage 
        (creating the module and the respective tests) and then opening a pull request with the changes. 
        
        For this, first you should check this repo's issues and check which modules are being worked on. Then, you can 
        check [turf.js](https://github.com/Turfjs/turf)'s github repo, choose a module not yet implemented 
        and then open an issue on this repo outlining the module you'll be working on, so that subsequent contributors can 
        follow the same logic outlined here.
        
        Make sure to pull and rebase from the upstream (this main repo) before you open the pull request.
         
Keywords: geospatial,geo
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
