Metadata-Version: 2.1
Name: seedfinder
Version: 0.1
Summary: Simple Python wrapper for seedfinder.eu's API
Home-page: https://github.com/hdb/seedfinder-python
Author: Hudson Bailey
Author-email: hudsondiggsbailey@gmail.com
License: MIT
Description: # seedfinder-python
        
        Simple Python wrapper for [seedfinder.eu](https://en.seedfinder.eu/)'s API.
        
        ## Install
        
        `pip install seedfinder`
        
        
        ## Setup
        
        You will need to [create an account](https://en.seedfinder.eu/register.html) at seedfinder.eu and [verify a domain or IP](https://en.seedfinder.eu/userarea/action/jsonapi.html) in order to access the API.
        
        To authorize requests, you need to either make a request from a verfied address or initialize the SeedFinder object with your API token.
        
        Note: seedfinder.eu requires that you register an address *even if you are only accessing the API by token*.
        
        ## Usage
        
        Initialize the API object
        
        ```python
        from seedfinder import SeedFinder
        
        sf = SeedFinder('YOUR API KEY')
        ```
        
        Search for strains
        
        ```python
        sf.searchStrain('fuel')
        ```
        
        Search for a strain using exact query
        
        ```python
        sf.searchStrain('Alien Kush', exact=True)
        ```
        
        Search by word and get detailed strain information from the first result
        
        ```python
        search_results = sf.searchStrain('purp')
        first_result = [v for k,v in search_results['strains'].items()][0]
        sf.strainInfo(first_result['id'], first_result['brid'])
        ```
        
        Get three generations of parent strains
        
        ```python
        sf.parents('Girl_Scout_Cookies', breeder_id='Clone_Only_Strains', generations=3)
        ```
        
        Get direct (first generation) hybrids
        
        ```python
        sf.hybrids('Puta_Breath', breeder_id='ThugPug_Genetics')
        ```
        
        List all of a breeder's strains
        
        ```python
        sf.breederInfo('Exotic_Genetix')
        ```
        
        ## API Documentation
        
        See seedfinder.eu's [API documentation](https://en.seedfinder.eu/api/json)
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
