From c2b2170320daa63f104bb503274019b37fde84b0 Mon Sep 17 00:00:00 2001 From: Mingwei Zhang Date: Mon, 24 Jun 2024 13:47:02 -0700 Subject: [PATCH] add changelog file --- CHANGELOG.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..51e90d8 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,23 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +## v0.1.0 -- 2024-06-24 + +Initial release of `as2org-rs`. + +### Highlights + +* automatically retrieve the most up-to-date CAIDA as-to-organization data +* `.get_as_info(ASN)` to retrieve information about an AS +* `.get_siblings(ASN)` to retrieve all siblings of an AS +* `.are_siblings(ASN1, ASN2)` to check if two ASes are siblings + +The main returning data structure is `As2orgAsInfo`, which contains the following fields: + +* `asn`: the AS number +* `name`: the name provide for the individual AS number +* `country_code`: the country code of the organization's registration country +* `org_id`: maps to an organization entry +* `org_name`: the name of the organization +* `source`: the RIR or NIR database which was contained this entry