mirror/peeringdb-peeringdb
1
0
Fork 0
mirror of https://github.com/peeringdb/peeringdb.git synced 2024-05-11 05:55:09 +00:00
Code Releases Activity

Docs 202109 (#1067)

Browse Source 
* module docstrings

* db schema graph

* dev docs first pass

* dev docs pass 2

* add generated notification to top of generated docs files

* linting

* regen docs

Co-authored-by: Stefan Pratter <stefan@20c.com>
Co-authored-by: Sunshine Buchholz <sunshine@20c.com>
This commit is contained in:
Matt Griswold
2021-10-15 03:25:38 -05:00
committed by GitHub
parent 48a3a899f6
commit c21130eed9
133 changed files with 9962 additions and 986 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
peeringdb_server/admin_commandline_tools.py
View File

@ -1,3 +1,12 @@
"""
Defines CLI wrappers for django commands that should
be executable through the django-admin interface.
Extend the CommandLineToolWrapper class and call the
register_tool decorator to add support for a new django
command to exposed in this manner.
"""
import io
import json
@ -193,7 +202,7 @@ class CommandLineToolWrapper:
class ToolRenumberLans(CommandLineToolWrapper):
"""
This tools runs the pdb_renumber_lans command to
Renumber IP Spaces in an Exchange
Renumber IP Spaces in an Exchange.
"""
tool = "pdb_renumber_lans"
@ -216,7 +225,7 @@ class ToolRenumberLans(CommandLineToolWrapper):
@property
def description(self):
"""Provide a human readable description of the command that was run"""
"""Provide a human readable description of the command that was run."""
try:
return "{}: {} to {}".format(
InternetExchange.objects.get(id=self.args[0]),
@ -241,7 +250,7 @@ class ToolRenumberLans(CommandLineToolWrapper):
class ToolMergeFacilities(CommandLineToolWrapper):
"""
This tool runs the pdb_fac_merge command to
merge two facilities
merge two facilities.
"""
tool = "pdb_fac_merge"
@ -261,7 +270,7 @@ class ToolMergeFacilities(CommandLineToolWrapper):
@property
def description(self):
"""Provide a human readable description of the command that was run"""
"""Provide a human readable description of the command that was run."""
return "{} into {}".format(
Facility.objects.get(id=self.kwargs["ids"]),
Facility.objects.get(id=self.kwargs["target"]),
@ -278,7 +287,7 @@ class ToolMergeFacilities(CommandLineToolWrapper):
class ToolMergeFacilitiesUndo(CommandLineToolWrapper):
"""
This tool runs the pdb_fac_merge_undo command to
undo a facility merge
undo a facility merge.
"""
tool = "pdb_fac_merge_undo"
@ -296,7 +305,7 @@ class ToolMergeFacilitiesUndo(CommandLineToolWrapper):
@property
def description(self):
"""Provide a human readable description of the command that was run"""
"""Provide a human readable description of the command that was run."""
# in order to make a useful description we need to collect the arguments
# from the merge command that was undone
@ -343,7 +352,7 @@ class ToolReset(CommandLineToolWrapper):
@register_tool
class ToolUndelete(CommandLineToolWrapper):
"""
Allows restoration of an object object and it's child objects
Allows restoration of an object object and it's child objects.
"""
tool = "pdb_undelete"