Metadata-Version: 2.1
Name: PyForks
Version: 0.0.19
Summary: A package to interface with Trailforks.com
Home-page: http://pypi.python.org/pypi/PyForks/
Author: Trailforks Python Library
Author-email: josh@mn-mtb.com
License: LICENSE.txt
Project-URL: Bug Reports, https://github.com/cribdragg3r/PyForks/issues
Project-URL: Funding, https://donate.pypi.org
Project-URL: Source, https://github.com/cribdragg3r/PyForks
Project-URL: Documentation, https://pyforks.mn-mtb.com
Description: <a href ="https://mn-mtb.com">
          <img src="./doc/PyForks.png"
            title="PyForks" align="left" height=100 length=100 />
            </a>
        
        
        # PyForks
        
        [![PyForks Tests](https://github.com/cribdragg3r/PyForks/actions/workflows/python-app.yml/badge.svg)](https://github.com/cribdragg3r/PyForks/actions/workflows/python-app.yml)
        [![GitHub](https://img.shields.io/github/license/cribdragg3r/PyForks?style=flat-square)](https://github.com/cribdragg3r/PyForks/blob/main/LICENSE)
        [![PyPI](https://img.shields.io/pypi/v/PyForks?style=flat-square)](https://pypi.org/project/PyForks/)
        [![codecov](https://codecov.io/gh/cribdragg3r/PyForks/branch/main/graph/badge.svg?token=225DIC4PVS)](https://codecov.io/gh/cribdragg3r/PyForks)
        
        
        Python Trailforks Library (Unofficial) for interacting with Trailforks.com. Help [support](https://github.com/sponsors/cribdragg3r) this project and more.
        
        ## About
        
        PyForks has been designed to help me automate much of the manual data aggregation I was doing in order to build metrics for my local city and state trail systems. For example: [app.mn-mtb.com](https://app.mn-mtb.com). The end goal of this project is the ability to make it much easier to pull data down that people are interested in and analyze it in a way that non-technical individuals can digest and understand impact in hopes of additional funding and interest. 
        
        This package uses the [Offical Trailforks API](https://www.trailforks.com/about/api). This means that in order to use this package, you must have a valid Trailforks `app_id` and `app_secret`. See the API link to get your keys.
        
        ## Installation & Documentation
        
        - Install: `pip install pyforks`
        - Documentation: [PyForks.mn-mtb.com](https://PyForks.mn-mtb.com)
        
        ### Quick Start
        
        **Get Information on a region**
        
        ```python
        from PyForks import Region
        import pandas as pd
        
        app_id = "id"
        app_secret = "secret"
        
        r = Region(app_id=app_id, app_secret=app_secret)
        if r.is_valid_region("west-lake-marion-park"):
          region_info_df = r.get_region_info("west-lake-marion-park")
          ridecount_df = r.get_region_ridecounts("west-lake-marion-park")
          
        ```
        ## Contribute
        
        Send all the pull requests you want!
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
