Metadata-Version: 1.2
Name: ukboards
Version: 0.5.0
Summary: Query UK company and charity board networks.
Home-page: https://github.com/griff-rees/ukboards
Author: Griffith Rees
Author-email: griff.rees@gmail.com
License: MIT
Description: =========
        UK Boards
        =========
        
        
        .. image:: https://img.shields.io/pypi/v/ukboards.svg
                :target: https://pypi.python.org/pypi/ukboards
        
        .. image:: https://img.shields.io/travis/griff-rees/ukboards.svg
                :target: https://travis-ci.org/griff-rees/ukboards
        
        .. image:: https://readthedocs.org/projects/ukboards/badge/?version=latest
                :target: https://ukboards.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        .. image:: https://pyup.io/repos/github/griff-rees/ukboards/shield.svg
                :target: https://pyup.io/repos/github/griff-rees/ukboards/
                :alt: Updates
        
        .. image:: https://img.shields.io/pypi/pyversions/ukboards.svg
                :target: https://img.shields.io/pypi/pyversions/ukboards
                :alt: Supported Python Versions
        
        .. image:: https://codecov.io/gh/griff-rees/ukboards/branch/master/graph/badge.svg
                :target: https://codecov.io/gh/griff-rees/ukboards
        
        
        Query UK company and charity board networks.
        
        
        * Free software: MIT License
        * Documentation: https://ukboards.readthedocs.io.
        
        
        Features
        --------
        
        * Command line interface for querying JSON data from the Companies House API
        * Support for https://developer.companieshouse.gov.uk/api/docs/
        * Support for https://apps.charitycommission.gov.uk/Showcharity/API/SearchCharitiesV1/Docs/DevGuideHome.aspx
        * Option to load keys for both APIs from a local `.env` file
        * Support for loading company and charity IDs from a CSV file
        * Alpha support for exporting networkx json files of board interlock structures
        
        Credits
        -------
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        =======
        History
        =======
        
        0.5.0 (2020-12-20)
        ------------------
        
        * Add classes for joint queries of companies and charities
        * Fix issues with Companies House pagination
        * Change library name from uk-boards to ukboards following PEP-8
        * Alpha-level customisation of networkx JSON network format
        * Options for adding geospatial data from postcodes.io
        
        0.4.0 (2020-01-07)
        ------------------
        
        * Refactor Companies House queries into separate query functions
        * Add a CompanyNetworkClient class for cacheable network queries
        
        0.3.0 (2019-12-18)
        ------------------
        
        * Add Charity Commission API querying via zeep library
        * Include Charity Commision API specification
        * Refactor command line interface
        
        0.2.0 (2019-11-18)
        ------------------
        
        * First use of bump2version
        
        0.1.4 (2019-11-18)
        ------------------
        
        * Fix PyPI versioning
        
        0.1.3 (2019-11-18)
        ------------------
        
        * Release on PyPI
        
        0.1.2 (2019-11-17)
        ------------------
        
        * Enable basic command line query of Companies House
        * Enable codecov
        
        0.1.1 (2019-11-13)
        ------------------
        
        * Improve function and variable names
        * Expand docstring of companies_house_query
        * Expand type hinting
        * pytest-remotedata plugin test for optional real query test
        
        0.1.0 (2019-11-11)
        ------------------
        
        * First release on PyPI.
        * Basic tests of querying from companies house
        
Keywords: ukboards
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*
