CompaniesHouse exporter

Export registration information from the UK Companies House into an Excel file

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact
6. Acknowledgements

About The Project

The module receives an Excel with UK company number and adds the current registration details (name, address, directors, next confirmation statement and annual account deadlines) from the Companies House API.

The main entry point file is companies_house_exporter.py

Built With

• Python 3.7
• Openpyxl

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Install all prerequisites from the included requirements.txt.

• pip install -r /path/to/requirements.txt

Installation

1. Clone the repo

   git clone https://github.com/github_shaishulman/CompaniesHouse_Exporter.git

2. Install prerequisites

   pip install -r /path/to/requirements.txt

3. Apply for a developer API from the Companies House

   https://developer.company-information.service.gov.uk/get-started

4. Save the API into a text file named "api_key.txt" (optional)

5. Prepae an Excel file with the registration numbers of the companies you are interested in (you use xls_file_template.xlsx)

Usage

• Get directors and next deadlines information for the companies listed on "xls_file_template.xlsx"

  python companies_house_exporter.py -n -d -f "xls_file_template.xlsx"

• Only get basic information and directly specify API key

  python companies_house_exporter.py -"xls_file_template.xlsx" -k 123456789

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Shai Shulman - @shaishulman - [email protected]

Project Link: https://github.com/github_shaishulman/CompaniesHouse_Exporter