Welcome to V3

V3 Update

New Features

Shift to Starlette: We've migrated from Flask to Starlette for our web framework. Starlette is a lightweight ASGI framework that is ideal for building high performance asyncio services.

• Asynchronous Programming: The application now supports asynchronous programming, allowing it to handle multiple requests simultaneously. This improves the overall performance and responsiveness of the application.

• Uvicorn Integration: Uvicorn, a lightning-fast ASGI server, has been integrated into the application. This provides a robust foundation for async web code.

• Improved Query Console: The query console has been enhanced to be more user-friendly and provide more helpful responses.

Improvements

• Simpler Container Build: The container build process has been simplified by using pure Docker. This makes the build process more straightforward and easier to manage.

• Removal of Nginx: Nginx has been removed from the stack. This simplifies the setup and reduces the resources required to run the application.

• Code Cleanups: Several code cleanups have been performed to improve readability and maintainability.

What's Changed

• V2.2.1 by @miha42-github in #30
• V2.2.1 by @miha42-github in #34
• V2.3.0 by @miha42-github in #35
• V3.0.0 dev by @miha42-github in #36

Full Changelog: V2.3.0-install-automation...V3.0_fix_1

V2.3.0 - Company_dns now easier to run

Release Notes - Version 2.3.0

We are excited to introduce Company DNS v2.3.0, which comes with several new features, improvements, and bug fixes to enhance your experience with the service.

New Features

Service Control Script (svc_ctl.sh)

We have added a new service control script, svc_ctl.sh, to simplify the process of running the Company DNS service. This script performs the following tasks:

1. Creates a required database cache containing SEC EDGAR data and Standard Industry Code data.
2. Builds the Docker image for the service.
3. Runs the Docker image detached from the console as a container service.
4. Allows you to tail the logs for the running container using the svc_ctl.sh tail command.

This service control script makes it easier than ever to set up and run the Company DNS service with minimal effort.

Bug Fixes

1. Improved Handling of Multiple Countries

We have fixed bugs in the lib/firmographics.py and lib/wikipedia.py modules to ensure that the service can handle requests involving multiple countries without crashing. This improvement enhances the stability and reliability of the service.

Database Control Utility Refactoring

2. Database Control Utility (dbcontrol.py) Refactored

We have refactored the Database Control Utility (dbcontrol.py) to include a configuration file, leading to an overall simplification of the code. Unnecessary code and comments have been removed, resulting in a more streamlined and efficient utility.

Repository Clean-Up

3. Repository Clean-Up

We have performed a comprehensive clean-up of the repository, including the removal of stale image files and directories. This enhances the organization and maintainability of the codebase.

Documentation Update

4. Documentation Update

The README.md files have been updated to reflect the current set of functions, including the newly added service control script. This update ensures that the documentation remains accurate and helpful for users.

---

We hope you enjoy using Company DNS v2.3.0. If you encounter any issues or have suggestions for further improvements, please don't hesitate to submit an issue on GitHub. Thank you for your continued support and feedback!

For detailed installation and usage instructions, please refer to the updated README.md file in the repository.

Full Changelog: V2.2.1-shoulda-been-2.2.3...V2.3.0-install-automation

Bug fixes and data/module attribution

Release Notes - company_dns v2.2.1

We're excited to announce the release of company_dns v2.2.1! This release includes several bug fixes and new features, including:

• Bug fix for public companies that have stale CIKs (Central Index Keys) have them only report wikipedia data
• Bug fix for companies which return multiple valid CIKs, in this scenario instead of reporting an error with two separate company objects only one company is reported
• Bug fix to return a not found error when non-company entities are searched for
• Feature that moves the embedded help to a /help endpoint
• Feature that attributes key used python modules model and data sets to their source
• Changes in how the lib/edgar.py module returns data such that it is in alignment with other modules
• Repository cleanups
• Overall improvements in error handling

New Features

Help Endpoint

We've moved the embedded help to a /help endpoint, which provides detailed information about how to use company_dns and its various endpoints. This new endpoint is accessible via the following URL:

• /help

Attribution of Python modules, models, and data sets

We've added a new feature that attributes the key used Python modules, models, and data sets to their source. This will make it easier for users to understand where the data is coming from and ensure that we are giving proper credit to the original sources.

Bug Fixes

Handling stale CIKs

We've fixed a bug that caused public companies with stale CIKs to only report Wikipedia data. Now, users will get the correct data when querying these companies.

Handling multiple valid CIKs

We've also fixed a bug that caused an error to be reported with two separate company objects when a company had multiple valid CIKs. Now, only one company will be reported in this scenario.

Handling non-company entities

We've fixed a bug that caused non-company entities to be searched for, resulting in an error. Now, users will receive a not found error when attempting to search for non-company entities.

Changes to edgar.py module

We've made changes to the lib/edgar.py module to ensure that it returns data in alignment with other modules.

What's Changed

• Add SIC endpoints updated sic data in edgar by @miha42-github in #28
• added desc metadata for sic returns by @miha42-github in #29

Full Changelog: V2.2.0-new-sic-behaviors...V2.2.1-shoulda-been-2.2.3

V2.2.0-new-sic-behaviors

Release Notes - company_dns v2.2.0

We're excited to announce the release of company_dns v2.2.0! This release includes several improvements and new features, including:

• Added additional RESTful endpoints for SIC data including lookups for major group by number, industry group by number, division by ID
• Fixed the RESTful endpoints for SIC-related data to better handle errors
• Enriched EDGAR data with SIC fields for division ID, division description, major group number, major group description, industry group number, and industry group description

New Features

Additional RESTful endpoints for SIC data

With the new version of company_dns, we have added additional RESTful endpoints that allow users to look up SIC data by major group number, industry group number, and division ID. These new endpoints can be accessed via the following URLs:

• /V2.0/sic/division/{id}
• /V2.0/sic/industry/{number}
• /V2.0/sic/major/{number}

Enriched EDGAR data with SIC fields

We've also enriched our EDGAR data with SIC fields, including division ID, division description, major group number, major group description, industry group number, and industry group description. This will provide users with more information about companies and their classifications.

What's Changed

• V2.1.0 by @miha42-github in #24
• Minor change to readme by @miha42-github in #27

Full Changelog: V2...V2.2.0-new-sic-behaviors

V2.1.0-sic_detail

Release Notes for company_dns v2.0.0

We are pleased to announce the release of company_dns v2.0.0! This release includes several new features and improvements that we believe will make company_dns even more useful and versatile.

New Features

Merging of Wikipedia and SEC EDGAR Data

In this release, we have merged the data from Wikipedia and SEC EDGAR to provide more comprehensive information about companies. Now, when you query a company using company_dns, you will get more data from these two sources.

SIC Lookups

We have also added SIC lookups to company_dns. You can now search for SIC detail by SIC code or description. This is particularly useful for industries that are classified using the SIC system, such as manufacturing, mining, and finance.

RESTful Endpoints

All of these new features are accessible via a series of RESTful endpoints. You can use these endpoints to retrieve data about companies, search for companies by SIC code or description, and more.

What's Changed

• Alpha wikipedia by @miha42-github in #5
• Alpha wikipedia by @miha42-github in #12
• Alpha by @miha42-github in #13
• Update README.md by @miha42-github in #14
• Update README.md by @miha42-github in #15
• Updated README.md and minor repo refactor by @miha42-github in #16
• Alpha - Improved response to include stock ticker and google links by @miha42-github in #20
• V2.1.0 add sic by @miha42-github in #23

Full Changelog: V1.0...V2

v1.0 - company DNS

The first operable release both a simple tool and RESTful service.

Initial release

v0.3

Updated the readme to reflect open sourcing the project