registerbekanntmachungen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d6e8c077be1fcf802c1b2bb310ee128ccf4c3c08d38aece2a851ecce25c4f3a
+  data.tar.gz: 2c36e536f4ef72e412d50b0e0f3207117ad04c3eac02b584635643ca5fca36f2
+SHA512:
+  metadata.gz: 2059587467850ca8e1166b49aff5c42526eeeec2cb7ed85a30528728976104a394a1575f6131f5ed2a87dc2447b79a0369f6d135a59839fa7997a3ccc37e89c1
+  data.tar.gz: 23f2429283f9bc19c5f68f37b913a3609cb5ad5d1db198cbe711d4bfb93297a05d8a3f97f3e0271262256292b8c2046a81795734811bc67b466775368aa9ed43

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-21
+
+- Initial release

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright 2024 Christopher Özbek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# Registerbekanntmachungen
+
+[![License MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+[![Daily Scrape CI](https://github.com/coezbek/registerbekanntmachungen/actions/workflows/daily_scrape.yml/badge.svg)](https://github.com/coezbek/registerbekanntmachungen/actions/workflows/daily_scrape.yml) 
+
+> [!IMPORTANT]
+> This project is not affiliated with handelsregister.de. It is not an official source of truth. This data may be incomplete or outdated. The tool might mangle or miss entries. Use at your own risk.
+
+This Ruby Gem provides a simple scraper for the "Registerbekanntmachungen" (notices of changes in corporate directory) announced by the [German Handelsregister on their page](https://www.handelsregister.de/rp_web/xhtml/bekanntmachungen.xhtml).
+
+These Registerbekanntmachungen only contain officially mandated publications such as those mandated by [Handelsgesetzbuch HGB §10](https://www.gesetze-im-internet.de/hgb/__10.html). It does not contain all changes in the corporate directory, only those that are required to be published (in particular declarations to delete i.e. 'Löschungen' and 'Umwandlungen'). 
+
+Since the data is static once published, small (only <= 200 announcements per day) and only the last 8 weeks are available at handelregister.de, this repository also hosts [daily snapshots](./db) of the data sorted by month in the `db` directory. In most cases, running the scraper yourself it thus unnecessary. 
+
+> [!IMPORTANT]
+> Handelsregister.de's Terms & Conditions mandates that users should not perform more than 60 'searches' or 'retrievals' per hour. Both terms are not defined it is thus not clear what constitutes either. It is unclear on what legal basis Handelsregister.de believes they have a right to impose such limits, since HGB makes no restrictions on an individuals ability to access these publically available information for the purpose of information. Since information on the handelsregister can be updated on a daily basis and there are no means of bulk 'retrievals', it could be argued that individuals must be able to perform as many accesses as are necessary to obtain all company information once per day. For the Registerbekanntmachungen this means on the order of 200 accesses per day per user.
+> Handelsregister.de also claims that material is copyrighted unless otherwise noted. Since all material which is available for access is provided by the register courts to handelsregister.de to ensure retrieval, it is unclear to what material they really claim copyright and why.
+
+## Related projects
+
+https://github.com/bundesAPI/handelsregister provides a Python CLI for accessing the Handelsregister itself. 
+
+## Usage / Installation
+
+To use the gem, best clone this repository:
+
+```bash
+git clone https://github.com/coezbek/registerbekanntmachungen
+cd registerbekanntmachungen
+bundle
+```
+
+Run the scraper in verbose mode for announcements published today:
+
+```bash
+bundle exec lib/registerbekanntmachungen.rb -v
+```
+
+All available option:
+
+```bash
+$ bundle exec lib/registerbekanntmachungen.rb --help
+Usage: registerbekanntmachungen [options]
+    -v, --verbose                    Enable verbose/debug output
+    -r, --reload                     Reload data and skip cache
+        --no-save                    Do not save any data just print to stdout
+        --start-date DATE            Start date in format DD.MM.YYYY or YYYY-MM-DD
+        --end-date DATE              End date in format DD.MM.YYYY or YYYY-MM-DD
+    -o, --oldest                     Download oldest available data not already saved
+    -y, --yesterday                  Download yesterday's data
+    -a, --all                        Download all data from the last 8 weeks
+        --no-headless                Don't run browser in headless mode
+    -h, --help                       Displays Help
+```
+
+*Note*: 
+- Data usually isn't published on weekends, but sometimes it is.
+- If you run this tool in the morning you might want to use it again in the evening/night, because new announcements are published throughout the day.
+- Data is only available for the last 8 weeks (7*8 = 56 days) on handelsregister.de. Use '-o' to obtain the data from the oldest available date.
+
+## Data SchemaAnnouncement types
+
+The data contains the following fields for each announcement:
+
+- `date`: The date the announcement was published as an ISO 8601 string, e.g. "2024-10-01".
+- `original_text`: The original link text of the announcement.
+- `court`: The court where the announcement was published, e.g. "Amtsgericht Berlin (Charlottenburg)".
+- `registernumber`: The register number of the company including the prefix (e.g. "HRB 12345" or "VR 123").
+- `registerart`: The type of the register, e.g. "HRA" for Handelsregister A or "VR" for Vereinsregister.
+- `company_name`: The name of the company, can include special characters.
+- `type`: The type of the announcement. Possible values I have observed so far:
+  - Sonderregisterbekanntmachung OHNE Bezug zum elektr. Register
+  - Löschungsankündigung
+  - Sonstige Registerbekanntmachung
+  - Registerbekanntmachung nach dem Umwandlungsgesetz
+  - Einreichung neuer Dokumente
+- `state`: The Federal State of Germany where the company is registered.
+- `company_seat`: The city where the company is registered.
+- `former_court`: In case the company registration was moved from another court, the name of the former court.
+- `details`: The text detail message shown on the handelsregister.de website.
+
+If an announcement is of type "Sonderregisterbekanntmachung OHNE Bezug zum elektr. Register", the available fields are different:
+
+- `date`, `state`, `court`, `company_name`, `type`, `details`, `original_text` are equally available
+- Instead of `registernumber` there is a `sonderegister_referenz`, which might be a registernumber but could be something else.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/coezbek/registerbekanntmachungen.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]