django-ixp-tracker 0.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. django_ixp_tracker-0.3/LICENSE +201 -0
  2. django_ixp_tracker-0.3/PKG-INFO +118 -0
  3. django_ixp_tracker-0.3/README.md +91 -0
  4. django_ixp_tracker-0.3/django_ixp_tracker.egg-info/PKG-INFO +118 -0
  5. django_ixp_tracker-0.3/django_ixp_tracker.egg-info/SOURCES.txt +31 -0
  6. django_ixp_tracker-0.3/django_ixp_tracker.egg-info/dependency_links.txt +1 -0
  7. django_ixp_tracker-0.3/django_ixp_tracker.egg-info/requires.txt +10 -0
  8. django_ixp_tracker-0.3/django_ixp_tracker.egg-info/top_level.txt +2 -0
  9. django_ixp_tracker-0.3/ixp_tracker/__init__.py +0 -0
  10. django_ixp_tracker-0.3/ixp_tracker/conf.py +25 -0
  11. django_ixp_tracker-0.3/ixp_tracker/importers.py +212 -0
  12. django_ixp_tracker-0.3/ixp_tracker/management/__init__.py +0 -0
  13. django_ixp_tracker-0.3/ixp_tracker/management/commands/__init__.py +0 -0
  14. django_ixp_tracker-0.3/ixp_tracker/management/commands/ixp_tracker_import.py +67 -0
  15. django_ixp_tracker-0.3/ixp_tracker/migrations/0001_initial.py +38 -0
  16. django_ixp_tracker-0.3/ixp_tracker/migrations/0002_asn_asn_unique_as_number.py +34 -0
  17. django_ixp_tracker-0.3/ixp_tracker/migrations/0003_alter_asn_name.py +18 -0
  18. django_ixp_tracker-0.3/ixp_tracker/migrations/0004_ixpmember_ixpmember_unique_ixp_membership.py +36 -0
  19. django_ixp_tracker-0.3/ixp_tracker/migrations/0005_statspercountry_statsperixp_and_more.py +55 -0
  20. django_ixp_tracker-0.3/ixp_tracker/migrations/0006_remove_statspercountry_ixp_tracker_unique_per_country_stats_and_more.py +36 -0
  21. django_ixp_tracker-0.3/ixp_tracker/migrations/__init__.py +0 -0
  22. django_ixp_tracker-0.3/ixp_tracker/models.py +115 -0
  23. django_ixp_tracker-0.3/ixp_tracker/stats.py +91 -0
  24. django_ixp_tracker-0.3/pyproject.toml +39 -0
  25. django_ixp_tracker-0.3/setup.cfg +4 -0
  26. django_ixp_tracker-0.3/tests/test_api_integration.py +96 -0
  27. django_ixp_tracker-0.3/tests/test_asns_import.py +100 -0
  28. django_ixp_tracker-0.3/tests/test_backfill_data.py +158 -0
  29. django_ixp_tracker-0.3/tests/test_country_stats.py +61 -0
  30. django_ixp_tracker-0.3/tests/test_ixp_stats.py +142 -0
  31. django_ixp_tracker-0.3/tests/test_ixps_import.py +74 -0
  32. django_ixp_tracker-0.3/tests/test_load_geo_lookup.py +31 -0
  33. django_ixp_tracker-0.3/tests/test_members_import.py +203 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,118 @@
1
+ Metadata-Version: 2.1
2
+ Name: django-ixp-tracker
3
+ Version: 0.3
4
+ Summary: Library to retrieve and manipulate data about IXPs
5
+ Author: Internet Society
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/InternetSociety/django-ixp-tracker
8
+ Project-URL: Changelog, https://github.com/InternetSociety/django-ixp-tracker/releases
9
+ Project-URL: Issues, https://github.com/InternetSociety/django-ixp-tracker/issues
10
+ Project-URL: CI, https://github.com/InternetSociety/django-ixp-tracker/actions
11
+ Classifier: License :: OSI Approved :: Apache Software License
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Operating System :: OS Independent
14
+ Classifier: Framework :: Django
15
+ Requires-Python: >=3.8
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ Requires-Dist: django>4.2
19
+ Requires-Dist: django-countries>7.6
20
+ Requires-Dist: python-dateutil
21
+ Provides-Extra: test
22
+ Requires-Dist: django-stubs; extra == "test"
23
+ Requires-Dist: pre-commit; extra == "test"
24
+ Requires-Dist: pytest; extra == "test"
25
+ Requires-Dist: pytest-django; extra == "test"
26
+ Requires-Dist: responses; extra == "test"
27
+
28
+ # django-ixp-tracker
29
+
30
+ [![PyPI](https://img.shields.io/pypi/v/django-ixp-tracker.svg)](https://pypi.org/project/django-ixp-tracker/)
31
+ [![Tests](https://github.com/InternetSociety/django-ixp-tracker/actions/workflows/test.yml/badge.svg)](https://github.com/InternetSociety/django-ixp-tracker/actions/workflows/test.yml)
32
+ [![Changelog](https://img.shields.io/github/v/release/InternetSociety/django-ixp-tracker?include_prereleases&label=changelog)](https://github.com/InternetSociety/django-ixp-tracker/releases)
33
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/InternetSociety/django-ixp-tracker/blob/main/LICENSE)
34
+
35
+ Library to retrieve and manipulate data about IXPs
36
+
37
+ ## Installation
38
+
39
+ Install this library using `pip`:
40
+ ```bash
41
+ pip install django-ixp-tracker
42
+ ```
43
+ ## Usage
44
+
45
+ 1. Add to your INSTALLED_APPS setting like this:
46
+ ```
47
+ INSTALLED_APPS = [
48
+ ...,
49
+ "ixp_tracker",
50
+ ]
51
+ ```
52
+
53
+ Note: this app has no web-facing components so you don't need to add anything to `urls.py` etc
54
+
55
+ 2. Run `python manage.py migrate` to create the models.
56
+ 3. Add the relevant settings to your config. `IXP_TRACKER_PEERING_DB_URL` will use a default if you don't provide a value so you probably don't need that. But you will need to set `IXP_TRACKER_PEERING_DB_KEY` to authenticate against the API.
57
+ 4. Add `IXP_TRACKER_GEO_LOOKUP_FACTORY` to config with the path to your factory (see below).
58
+ 5. Run the management command to import the data: `python manage.py ixp_tracker_import` (This will sync the current data, if you want historical data you need to backfill first)
59
+
60
+ ## ASN country and status data
61
+
62
+ The lib uses an external component to look up the country of registration (why?) and the status of an ASN. This status is used for the logic to identify when members have left an IXP.
63
+
64
+ If you don't provide this service yourself, it will default to a noop version. This will mean you will get no country of registration data and the marking of members having left an IXP will not be as efficient.
65
+
66
+ In order to implement such a component yourself, you should implement the Protocol `ixp_tracker.importers.ASNGeoLookup` and provide a factory function for your class.
67
+
68
+ ## Backfilling data
69
+
70
+ You have the option of backfilling data from archived PeeringDb data. This can be done by running the import command with the `--backfill` option for each month you want to backfill:
71
+ ```shell
72
+ python manage.py ixp_tracker_import --backfill <YYYMM>
73
+ ```
74
+ The backfill currently process a single month at a time and will look for the earliest file for the relevant month at https://publicdata.caida.org/datasets/peeringdb/
75
+
76
+ IMPORTANT NOTE: due to the way the code tries to figure out when a member left an IXP, you should run the backfill strictly in date order and *before* syncing the current data.
77
+
78
+ ## IXP stats
79
+
80
+ The import process also generates monthly stats per IXP and per country. These are generated as of the 1st of the month used to import the data.
81
+
82
+ ## Running programmatically
83
+
84
+ If you'd like to run the import from code, rather than from the management command, you can call `importers.import_data()` directly.
85
+
86
+ It's not recommended to call any other functions yourself.
87
+
88
+ ## Development
89
+
90
+ To contribute to this library, first checkout the code. Then create a new virtual environment:
91
+ ```bash
92
+ cd django-ixp-tracker
93
+ python -m venv venv
94
+ source venv/bin/activate
95
+ ```
96
+ Now install the dependencies and test dependencies:
97
+ ```bash
98
+ pip install -e '.[test]'
99
+ ```
100
+ To run the tests:
101
+ ```bash
102
+ pytest
103
+ ```
104
+ We use [pre-commit](https://pre-commit.com/) for linting etc on push. Run:
105
+ ```bash
106
+ pre-commit install
107
+ ```
108
+ from the repo top-level dir to set it up.
109
+
110
+ ## Peering Db libraries
111
+
112
+ PeeringDb provide their own [vanilla Python](https://github.com/peeringdb/peeringdb-py) and [Django](https://github.com/peeringdb/django-peeringdb) libs, but we have decided not to use these.
113
+
114
+ Both libs are designed to keep a local copy of the current data and to keep that copy in sync with the central copy via the API.
115
+
116
+ As we need to keep a historical record (e.g. for IXP growth stats over time), we would have to provide some sort of wrapper over those libs anyway.
117
+
118
+ In addition to that, the [historical archives of PeeringDb data](https://publicdata.caida.org/datasets/peeringdb/) use flat lists of the different object types in json. We can retrieve the data from the API directly in the same way, so it makes it simpler to implement.
@@ -0,0 +1,91 @@
1
+ # django-ixp-tracker
2
+
3
+ [![PyPI](https://img.shields.io/pypi/v/django-ixp-tracker.svg)](https://pypi.org/project/django-ixp-tracker/)
4
+ [![Tests](https://github.com/InternetSociety/django-ixp-tracker/actions/workflows/test.yml/badge.svg)](https://github.com/InternetSociety/django-ixp-tracker/actions/workflows/test.yml)
5
+ [![Changelog](https://img.shields.io/github/v/release/InternetSociety/django-ixp-tracker?include_prereleases&label=changelog)](https://github.com/InternetSociety/django-ixp-tracker/releases)
6
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/InternetSociety/django-ixp-tracker/blob/main/LICENSE)
7
+
8
+ Library to retrieve and manipulate data about IXPs
9
+
10
+ ## Installation
11
+
12
+ Install this library using `pip`:
13
+ ```bash
14
+ pip install django-ixp-tracker
15
+ ```
16
+ ## Usage
17
+
18
+ 1. Add to your INSTALLED_APPS setting like this:
19
+ ```
20
+ INSTALLED_APPS = [
21
+ ...,
22
+ "ixp_tracker",
23
+ ]
24
+ ```
25
+
26
+ Note: this app has no web-facing components so you don't need to add anything to `urls.py` etc
27
+
28
+ 2. Run `python manage.py migrate` to create the models.
29
+ 3. Add the relevant settings to your config. `IXP_TRACKER_PEERING_DB_URL` will use a default if you don't provide a value so you probably don't need that. But you will need to set `IXP_TRACKER_PEERING_DB_KEY` to authenticate against the API.
30
+ 4. Add `IXP_TRACKER_GEO_LOOKUP_FACTORY` to config with the path to your factory (see below).
31
+ 5. Run the management command to import the data: `python manage.py ixp_tracker_import` (This will sync the current data, if you want historical data you need to backfill first)
32
+
33
+ ## ASN country and status data
34
+
35
+ The lib uses an external component to look up the country of registration (why?) and the status of an ASN. This status is used for the logic to identify when members have left an IXP.
36
+
37
+ If you don't provide this service yourself, it will default to a noop version. This will mean you will get no country of registration data and the marking of members having left an IXP will not be as efficient.
38
+
39
+ In order to implement such a component yourself, you should implement the Protocol `ixp_tracker.importers.ASNGeoLookup` and provide a factory function for your class.
40
+
41
+ ## Backfilling data
42
+
43
+ You have the option of backfilling data from archived PeeringDb data. This can be done by running the import command with the `--backfill` option for each month you want to backfill:
44
+ ```shell
45
+ python manage.py ixp_tracker_import --backfill <YYYMM>
46
+ ```
47
+ The backfill currently process a single month at a time and will look for the earliest file for the relevant month at https://publicdata.caida.org/datasets/peeringdb/
48
+
49
+ IMPORTANT NOTE: due to the way the code tries to figure out when a member left an IXP, you should run the backfill strictly in date order and *before* syncing the current data.
50
+
51
+ ## IXP stats
52
+
53
+ The import process also generates monthly stats per IXP and per country. These are generated as of the 1st of the month used to import the data.
54
+
55
+ ## Running programmatically
56
+
57
+ If you'd like to run the import from code, rather than from the management command, you can call `importers.import_data()` directly.
58
+
59
+ It's not recommended to call any other functions yourself.
60
+
61
+ ## Development
62
+
63
+ To contribute to this library, first checkout the code. Then create a new virtual environment:
64
+ ```bash
65
+ cd django-ixp-tracker
66
+ python -m venv venv
67
+ source venv/bin/activate
68
+ ```
69
+ Now install the dependencies and test dependencies:
70
+ ```bash
71
+ pip install -e '.[test]'
72
+ ```
73
+ To run the tests:
74
+ ```bash
75
+ pytest
76
+ ```
77
+ We use [pre-commit](https://pre-commit.com/) for linting etc on push. Run:
78
+ ```bash
79
+ pre-commit install
80
+ ```
81
+ from the repo top-level dir to set it up.
82
+
83
+ ## Peering Db libraries
84
+
85
+ PeeringDb provide their own [vanilla Python](https://github.com/peeringdb/peeringdb-py) and [Django](https://github.com/peeringdb/django-peeringdb) libs, but we have decided not to use these.
86
+
87
+ Both libs are designed to keep a local copy of the current data and to keep that copy in sync with the central copy via the API.
88
+
89
+ As we need to keep a historical record (e.g. for IXP growth stats over time), we would have to provide some sort of wrapper over those libs anyway.
90
+
91
+ In addition to that, the [historical archives of PeeringDb data](https://publicdata.caida.org/datasets/peeringdb/) use flat lists of the different object types in json. We can retrieve the data from the API directly in the same way, so it makes it simpler to implement.
@@ -0,0 +1,118 @@
1
+ Metadata-Version: 2.1
2
+ Name: django-ixp-tracker
3
+ Version: 0.3
4
+ Summary: Library to retrieve and manipulate data about IXPs
5
+ Author: Internet Society
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/InternetSociety/django-ixp-tracker
8
+ Project-URL: Changelog, https://github.com/InternetSociety/django-ixp-tracker/releases
9
+ Project-URL: Issues, https://github.com/InternetSociety/django-ixp-tracker/issues
10
+ Project-URL: CI, https://github.com/InternetSociety/django-ixp-tracker/actions
11
+ Classifier: License :: OSI Approved :: Apache Software License
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Operating System :: OS Independent
14
+ Classifier: Framework :: Django
15
+ Requires-Python: >=3.8
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ Requires-Dist: django>4.2
19
+ Requires-Dist: django-countries>7.6
20
+ Requires-Dist: python-dateutil
21
+ Provides-Extra: test
22
+ Requires-Dist: django-stubs; extra == "test"
23
+ Requires-Dist: pre-commit; extra == "test"
24
+ Requires-Dist: pytest; extra == "test"
25
+ Requires-Dist: pytest-django; extra == "test"
26
+ Requires-Dist: responses; extra == "test"
27
+
28
+ # django-ixp-tracker
29
+
30
+ [![PyPI](https://img.shields.io/pypi/v/django-ixp-tracker.svg)](https://pypi.org/project/django-ixp-tracker/)
31
+ [![Tests](https://github.com/InternetSociety/django-ixp-tracker/actions/workflows/test.yml/badge.svg)](https://github.com/InternetSociety/django-ixp-tracker/actions/workflows/test.yml)
32
+ [![Changelog](https://img.shields.io/github/v/release/InternetSociety/django-ixp-tracker?include_prereleases&label=changelog)](https://github.com/InternetSociety/django-ixp-tracker/releases)
33
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/InternetSociety/django-ixp-tracker/blob/main/LICENSE)
34
+
35
+ Library to retrieve and manipulate data about IXPs
36
+
37
+ ## Installation
38
+
39
+ Install this library using `pip`:
40
+ ```bash
41
+ pip install django-ixp-tracker
42
+ ```
43
+ ## Usage
44
+
45
+ 1. Add to your INSTALLED_APPS setting like this:
46
+ ```
47
+ INSTALLED_APPS = [
48
+ ...,
49
+ "ixp_tracker",
50
+ ]
51
+ ```
52
+
53
+ Note: this app has no web-facing components so you don't need to add anything to `urls.py` etc
54
+
55
+ 2. Run `python manage.py migrate` to create the models.
56
+ 3. Add the relevant settings to your config. `IXP_TRACKER_PEERING_DB_URL` will use a default if you don't provide a value so you probably don't need that. But you will need to set `IXP_TRACKER_PEERING_DB_KEY` to authenticate against the API.
57
+ 4. Add `IXP_TRACKER_GEO_LOOKUP_FACTORY` to config with the path to your factory (see below).
58
+ 5. Run the management command to import the data: `python manage.py ixp_tracker_import` (This will sync the current data, if you want historical data you need to backfill first)
59
+
60
+ ## ASN country and status data
61
+
62
+ The lib uses an external component to look up the country of registration (why?) and the status of an ASN. This status is used for the logic to identify when members have left an IXP.
63
+
64
+ If you don't provide this service yourself, it will default to a noop version. This will mean you will get no country of registration data and the marking of members having left an IXP will not be as efficient.
65
+
66
+ In order to implement such a component yourself, you should implement the Protocol `ixp_tracker.importers.ASNGeoLookup` and provide a factory function for your class.
67
+
68
+ ## Backfilling data
69
+
70
+ You have the option of backfilling data from archived PeeringDb data. This can be done by running the import command with the `--backfill` option for each month you want to backfill:
71
+ ```shell
72
+ python manage.py ixp_tracker_import --backfill <YYYMM>
73
+ ```
74
+ The backfill currently process a single month at a time and will look for the earliest file for the relevant month at https://publicdata.caida.org/datasets/peeringdb/
75
+
76
+ IMPORTANT NOTE: due to the way the code tries to figure out when a member left an IXP, you should run the backfill strictly in date order and *before* syncing the current data.
77
+
78
+ ## IXP stats
79
+
80
+ The import process also generates monthly stats per IXP and per country. These are generated as of the 1st of the month used to import the data.
81
+
82
+ ## Running programmatically
83
+
84
+ If you'd like to run the import from code, rather than from the management command, you can call `importers.import_data()` directly.
85
+
86
+ It's not recommended to call any other functions yourself.
87
+
88
+ ## Development
89
+
90
+ To contribute to this library, first checkout the code. Then create a new virtual environment:
91
+ ```bash
92
+ cd django-ixp-tracker
93
+ python -m venv venv
94
+ source venv/bin/activate
95
+ ```
96
+ Now install the dependencies and test dependencies:
97
+ ```bash
98
+ pip install -e '.[test]'
99
+ ```
100
+ To run the tests:
101
+ ```bash
102
+ pytest
103
+ ```
104
+ We use [pre-commit](https://pre-commit.com/) for linting etc on push. Run:
105
+ ```bash
106
+ pre-commit install
107
+ ```
108
+ from the repo top-level dir to set it up.
109
+
110
+ ## Peering Db libraries
111
+
112
+ PeeringDb provide their own [vanilla Python](https://github.com/peeringdb/peeringdb-py) and [Django](https://github.com/peeringdb/django-peeringdb) libs, but we have decided not to use these.
113
+
114
+ Both libs are designed to keep a local copy of the current data and to keep that copy in sync with the central copy via the API.
115
+
116
+ As we need to keep a historical record (e.g. for IXP growth stats over time), we would have to provide some sort of wrapper over those libs anyway.
117
+
118
+ In addition to that, the [historical archives of PeeringDb data](https://publicdata.caida.org/datasets/peeringdb/) use flat lists of the different object types in json. We can retrieve the data from the API directly in the same way, so it makes it simpler to implement.
@@ -0,0 +1,31 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ django_ixp_tracker.egg-info/PKG-INFO
5
+ django_ixp_tracker.egg-info/SOURCES.txt
6
+ django_ixp_tracker.egg-info/dependency_links.txt
7
+ django_ixp_tracker.egg-info/requires.txt
8
+ django_ixp_tracker.egg-info/top_level.txt
9
+ ixp_tracker/__init__.py
10
+ ixp_tracker/conf.py
11
+ ixp_tracker/importers.py
12
+ ixp_tracker/models.py
13
+ ixp_tracker/stats.py
14
+ ixp_tracker/management/__init__.py
15
+ ixp_tracker/management/commands/__init__.py
16
+ ixp_tracker/management/commands/ixp_tracker_import.py
17
+ ixp_tracker/migrations/0001_initial.py
18
+ ixp_tracker/migrations/0002_asn_asn_unique_as_number.py
19
+ ixp_tracker/migrations/0003_alter_asn_name.py
20
+ ixp_tracker/migrations/0004_ixpmember_ixpmember_unique_ixp_membership.py
21
+ ixp_tracker/migrations/0005_statspercountry_statsperixp_and_more.py
22
+ ixp_tracker/migrations/0006_remove_statspercountry_ixp_tracker_unique_per_country_stats_and_more.py
23
+ ixp_tracker/migrations/__init__.py
24
+ tests/test_api_integration.py
25
+ tests/test_asns_import.py
26
+ tests/test_backfill_data.py
27
+ tests/test_country_stats.py
28
+ tests/test_ixp_stats.py
29
+ tests/test_ixps_import.py
30
+ tests/test_load_geo_lookup.py
31
+ tests/test_members_import.py
@@ -0,0 +1,10 @@
1
+ django>4.2
2
+ django-countries>7.6
3
+ python-dateutil
4
+
5
+ [test]
6
+ django-stubs
7
+ pre-commit
8
+ pytest
9
+ pytest-django
10
+ responses
@@ -0,0 +1,2 @@
1
+ dist
2
+ ixp_tracker
File without changes
@@ -0,0 +1,25 @@
1
+ from django.conf import settings
2
+ from django.core.exceptions import ImproperlyConfigured
3
+
4
+ try:
5
+ IXP_TRACKER_GEO_LOOKUP_FACTORY = str(settings.IXP_TRACKER_GEO_LOOKUP_FACTORY)
6
+ except AttributeError:
7
+ IXP_TRACKER_GEO_LOOKUP_FACTORY = None
8
+ except(TypeError, ValueError):
9
+ raise ImproperlyConfigured("IXP_TRACKER_GEO_LOOKUP_FACTORY must be a string value")
10
+
11
+ try:
12
+ IXP_TRACKER_PEERING_DB_URL = str(settings.IXP_TRACKER_PEERING_DB_URL)
13
+ except AttributeError:
14
+ IXP_TRACKER_PEERING_DB_URL = "https://www.peeringdb.com/api"
15
+ except(TypeError, ValueError):
16
+ raise ImproperlyConfigured("IXP_TRACKER_PEERING_DB_URL must be a string value")
17
+
18
+ try:
19
+ IXP_TRACKER_PEERING_DB_KEY = str(settings.IXP_TRACKER_PEERING_DB_KEY)
20
+ except AttributeError:
21
+ IXP_TRACKER_PEERING_DB_KEY = None
22
+ except(TypeError, ValueError):
23
+ raise ImproperlyConfigured("IXP_TRACKER_PEERING_DB_KEY must be a string value")
24
+
25
+ DATA_ARCHIVE_URL = "https://publicdata.caida.org/datasets/peeringdb/{year}/{month:02d}/peeringdb_2_dump_{year}_{month:02d}_{day:02d}.json"