CompaniesHouse

An Elixir client for the Companies House API.

Installation

The package can be installed by adding companies_house to your list of dependencies in mix.exs:

def deps do
  [
    {:companies_house, "~> 0.2"}
  ]
end

Development

Requirements

• Elixir (see .tool-versions or mix.exs for version)
• Homebrew (for installing pre-commit hook dependencies)

Setup

bin/setup
mix setup

bin/setup installs the pre-commit hook tools (actionlint, check-jsonschema, lefthook, markdownlint-cli2) and activates the hooks. mix setup fetches Elixir dependencies.

Common commands

mix test          # Run tests
mix credo         # Lint
mix format        # Format code
mix coveralls     # Test coverage

License

CompaniesHouse is released under the MIT license.