Data

Tools

Indexes

Applications

Experiments

Open Source Science

ukboards

https://github.com/griff-rees/ukboards

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: griff-rees
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 658 KB
Statistics
  • Stars: 8
  • Watchers: 1
  • Forks: 0
  • Open Issues: 19
  • Releases: 3
Created over 6 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog Contributing License Citation Authors

README.rst 

=========
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

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4381055.svg
        :target: https://doi.org/10.5281/zenodo.4381055


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


For Contributors
----------------
 
`Pull Requests`_ (PRs), are welcome, especially if tests of contribution are included.  

This repository participated in a study of `sustainability of open source projects`_ following this `participant information sheet`_. Data was gathered for approximately 12 months, starting from 13 May 2021.


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
.. _`Pull Requests`: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request
.. _`sustainability of open source projects`: https://sustainable-open-science-and-software.github.io/
.. _`participant information sheet`: https://sustainable-open-science-and-software.github.io/assets/PIS_sustainable_software.pdf

Owner

  • Login: griff-rees
  • Kind: user

Citation (CITATION.cff) 

cff-version: 0.1.2
title: "ukboards: a python library for querying UK board interlock network data"
abstract: "A Python library for snowball sampling company and charity board (interlock) network data from the UK Companies House and Charities Commission APIs. Built on NetworkX bimodal (bipartite) configuration. Optional Geospatial data at the postcode level is implemented via the postcodes.io API. Can export a modification of the standard NetworkX JSON structure with additional meta data including timestamps and query parameters."
message: "If you use this software, please cite it as below."
license: MIT
authors:
  - affiliation: "The Alan Turing Institute"
    family-names: Rees
    given-names: Griffith
    orcid: https://orcid.org/000-0001-7281-4116
  - affiliation: "University of Sheffield"
    family-names: Taylor
    given-names: Mark
    orcid: https://orcid.org/0000-0001-5943-9796
version: v0.5.5
repository-code: https://github.com/griff-rees/ukboards
doi: 10.5281/zenodo.4381054
date-released: 2021-09-05

GitHub Events

Total
  • Push event: 21
  • Create event: 21
Last Year
  • Push event: 21
  • Create event: 21

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 428
  • Total Committers: 4
  • Avg Commits per committer: 107.0
  • Development Distribution Score (DDS): 0.467
Top Committers
Name Email Commits
pyup-bot g****t@p****o 228
Dr Griffith Rees g****s@g****m 177
dependabot[bot] 4****]@u****m 19
griff-rees 6****s@u****m 4
Committer Domains (Top 20 + Academic)
pyup.io: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 153
  • Average time to close issues: N/A
  • Average time to close pull requests: 21 days
  • Total issue authors: 0
  • Total pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 0.58
  • Merged pull requests: 42
  • Bot issues: 0
  • Bot pull requests: 80
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (95)
  • pyup-bot (72)
  • renovate[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (95)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 15 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 4
  • Total maintainers: 1
pypi.org: ukboards

Query UK company and charity board networks.

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 15 Last month
Rankings
Dependent packages count: 10.0%
Stargazers count: 18.5%
Dependent repos count: 21.7%
Average: 23.7%
Forks count: 29.8%
Downloads: 38.6%
Maintainers (1)
griff_rees
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • Click ==8.1.2
  • networkx ==2.6.3
  • python-dotenv ==0.20.0
  • requests ==2.27.1
  • zeep ==4.1.0
dev-requirements.txt pypi
  • Sphinx ==4.4.0
  • bump2version ==1.0.1
  • coverage ==6.4
  • flake8 ==4.0.1
  • ipython >=7.16.1
  • pip ==22.0.3
  • pre-commit ==2.19.0
  • pytest ==7.1.2
  • pytest-asyncio ==0.18.3
  • pytest-benchmark ==3.4.1
  • pytest-cov ==3.0.0
  • pytest-remotedata ==0.3.3
  • pytest-sugar ==0.9.4
  • requests-mock ==1.9.3
  • tox ==3.25.0
  • twine ==4.0.0
  • watchdog ==2.1.8
  • wheel ==0.37.1
.github/workflows/python-package.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite