Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/willnilges/pymeshdb

Python Client for MeshDB
https://github.com/willnilges/pymeshdb
Last synced: about 1 month ago
JSON representation
Python Client for MeshDB
Host: GitHub
URL: https://github.com/willnilges/pymeshdb
Owner: WillNilges
Created: 2024-05-27T22:09:47.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-09-28T07:01:13.000Z (4 months ago)
Last Synced: 2024-11-05T13:11:36.591Z (3 months ago)
Language: Python
Size: 186 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        # pymeshdb

Programmatic access to mesh core data, detailing our installs, members, etc. 

To use an authorization token, use the \"Authorize\" button, and under \"tokenAuth\" enter `Token ` before the content of your token, like this: `Token xxxyyyyyzzz`

If you have username/password credentials (like those used on the admin UI) you can login via the admin UI or [DRF login page](/auth/login/?next=/api-docs/swagger/)

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0

- Package version: 1.0.0

- Generator version: 7.7.0-SNAPSHOT

- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.7+

## Installation & Usage

### pip install

If the python package is hosted on a repository, you can install directly using:

```sh

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

```

(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:

```python

import pymeshdb

```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh

python setup.py install --user

```

(or `sudo python setup.py install` to install the package for all users)

Then import the package:

```python

import pymeshdb

```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import pymeshdb

from pymeshdb.rest import ApiException

from pprint import pprint

# Defining the host is optional and defaults to http://localhost

# See configuration.py for a list of all supported configuration parameters.

configuration = pymeshdb.Configuration(

    host = "http://localhost"

)

# Enter a context with an instance of the API client

with pymeshdb.ApiClient(configuration) as api_client:

    # Create an instance of the API class

    api_instance = pymeshdb.APIStatusApi(api_client)

    try:

        # Check API status

        api_response = api_instance.api_v1_retrieve()

        print("The response of APIStatusApi->api_v1_retrieve:\n")

        pprint(api_response)

    except ApiException as e:

        print("Exception when calling APIStatusApi->api_v1_retrieve: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*APIStatusApi* | [**api_v1_retrieve**](docs/APIStatusApi.md#api_v1_retrieve) | **GET** /api/v1/ | Check API status

*AccessPointsApi* | [**api_v1_accesspoints_create**](docs/AccessPointsApi.md#api_v1_accesspoints_create) | **POST** /api/v1/accesspoints/ | 

*AccessPointsApi* | [**api_v1_accesspoints_destroy**](docs/AccessPointsApi.md#api_v1_accesspoints_destroy) | **DELETE** /api/v1/accesspoints/{id}/ | 

*AccessPointsApi* | [**api_v1_accesspoints_list**](docs/AccessPointsApi.md#api_v1_accesspoints_list) | **GET** /api/v1/accesspoints/ | 

*AccessPointsApi* | [**api_v1_accesspoints_lookup_list**](docs/AccessPointsApi.md#api_v1_accesspoints_lookup_list) | **GET** /api/v1/accesspoints/lookup/ | 

*AccessPointsApi* | [**api_v1_accesspoints_partial_update**](docs/AccessPointsApi.md#api_v1_accesspoints_partial_update) | **PATCH** /api/v1/accesspoints/{id}/ | 

*AccessPointsApi* | [**api_v1_accesspoints_retrieve**](docs/AccessPointsApi.md#api_v1_accesspoints_retrieve) | **GET** /api/v1/accesspoints/{id}/ | 

*AccessPointsApi* | [**api_v1_accesspoints_update**](docs/AccessPointsApi.md#api_v1_accesspoints_update) | **PUT** /api/v1/accesspoints/{id}/ | 

*BuildingsApi* | [**api_v1_buildings_create**](docs/BuildingsApi.md#api_v1_buildings_create) | **POST** /api/v1/buildings/ | 

*BuildingsApi* | [**api_v1_buildings_destroy**](docs/BuildingsApi.md#api_v1_buildings_destroy) | **DELETE** /api/v1/buildings/{id}/ | 

*BuildingsApi* | [**api_v1_buildings_list**](docs/BuildingsApi.md#api_v1_buildings_list) | **GET** /api/v1/buildings/ | 

*BuildingsApi* | [**api_v1_buildings_lookup_list**](docs/BuildingsApi.md#api_v1_buildings_lookup_list) | **GET** /api/v1/buildings/lookup/ | 

*BuildingsApi* | [**api_v1_buildings_partial_update**](docs/BuildingsApi.md#api_v1_buildings_partial_update) | **PATCH** /api/v1/buildings/{id}/ | 

*BuildingsApi* | [**api_v1_buildings_retrieve**](docs/BuildingsApi.md#api_v1_buildings_retrieve) | **GET** /api/v1/buildings/{id}/ | 

*BuildingsApi* | [**api_v1_buildings_update**](docs/BuildingsApi.md#api_v1_buildings_update) | **PUT** /api/v1/buildings/{id}/ | 

*DevicesApi* | [**api_v1_devices_create**](docs/DevicesApi.md#api_v1_devices_create) | **POST** /api/v1/devices/ | 

*DevicesApi* | [**api_v1_devices_destroy**](docs/DevicesApi.md#api_v1_devices_destroy) | **DELETE** /api/v1/devices/{id}/ | 

*DevicesApi* | [**api_v1_devices_list**](docs/DevicesApi.md#api_v1_devices_list) | **GET** /api/v1/devices/ | 

*DevicesApi* | [**api_v1_devices_lookup_list**](docs/DevicesApi.md#api_v1_devices_lookup_list) | **GET** /api/v1/devices/lookup/ | 

*DevicesApi* | [**api_v1_devices_partial_update**](docs/DevicesApi.md#api_v1_devices_partial_update) | **PATCH** /api/v1/devices/{id}/ | 

*DevicesApi* | [**api_v1_devices_retrieve**](docs/DevicesApi.md#api_v1_devices_retrieve) | **GET** /api/v1/devices/{id}/ | 

*DevicesApi* | [**api_v1_devices_update**](docs/DevicesApi.md#api_v1_devices_update) | **PUT** /api/v1/devices/{id}/ | 

*GeographicKMLDataApi* | [**api_v1_geography_nyc_geocode_v2_search_retrieve**](docs/GeographicKMLDataApi.md#api_v1_geography_nyc_geocode_v2_search_retrieve) | **GET** /api/v1/geography/nyc-geocode/v2/search | Use the NYC geocoding APIs to look up an address, and return the lat/lon/alt corresponding to it or 404 if the address cannot be found within NYC

*GeographicKMLDataApi* | [**api_v1_geography_whole_mesh_kml_retrieve**](docs/GeographicKMLDataApi.md#api_v1_geography_whole_mesh_kml_retrieve) | **GET** /api/v1/geography/whole-mesh.kml | Generate a KML file which contains all nodes and links on the mesh

*InstallsApi* | [**api_v1_installs_create**](docs/InstallsApi.md#api_v1_installs_create) | **POST** /api/v1/installs/ | 

*InstallsApi* | [**api_v1_installs_destroy**](docs/InstallsApi.md#api_v1_installs_destroy) | **DELETE** /api/v1/installs/{id}/ | 

*InstallsApi* | [**api_v1_installs_destroy2**](docs/InstallsApi.md#api_v1_installs_destroy2) | **DELETE** /api/v1/installs/{install_number}/ | 

*InstallsApi* | [**api_v1_installs_list**](docs/InstallsApi.md#api_v1_installs_list) | **GET** /api/v1/installs/ | 

*InstallsApi* | [**api_v1_installs_lookup_list**](docs/InstallsApi.md#api_v1_installs_lookup_list) | **GET** /api/v1/installs/lookup/ | 

*InstallsApi* | [**api_v1_installs_partial_update**](docs/InstallsApi.md#api_v1_installs_partial_update) | **PATCH** /api/v1/installs/{id}/ | 

*InstallsApi* | [**api_v1_installs_partial_update2**](docs/InstallsApi.md#api_v1_installs_partial_update2) | **PATCH** /api/v1/installs/{install_number}/ | 

*InstallsApi* | [**api_v1_installs_retrieve**](docs/InstallsApi.md#api_v1_installs_retrieve) | **GET** /api/v1/installs/{id}/ | 

*InstallsApi* | [**api_v1_installs_retrieve2**](docs/InstallsApi.md#api_v1_installs_retrieve2) | **GET** /api/v1/installs/{install_number}/ | 

*InstallsApi* | [**api_v1_installs_update**](docs/InstallsApi.md#api_v1_installs_update) | **PUT** /api/v1/installs/{id}/ | 

*InstallsApi* | [**api_v1_installs_update2**](docs/InstallsApi.md#api_v1_installs_update2) | **PUT** /api/v1/installs/{install_number}/ | 

*LOSesApi* | [**api_v1_loses_create**](docs/LOSesApi.md#api_v1_loses_create) | **POST** /api/v1/loses/ | 

*LOSesApi* | [**api_v1_loses_destroy**](docs/LOSesApi.md#api_v1_loses_destroy) | **DELETE** /api/v1/loses/{id}/ | 

*LOSesApi* | [**api_v1_loses_list**](docs/LOSesApi.md#api_v1_loses_list) | **GET** /api/v1/loses/ | 

*LOSesApi* | [**api_v1_loses_lookup_list**](docs/LOSesApi.md#api_v1_loses_lookup_list) | **GET** /api/v1/loses/lookup/ | 

*LOSesApi* | [**api_v1_loses_partial_update**](docs/LOSesApi.md#api_v1_loses_partial_update) | **PATCH** /api/v1/loses/{id}/ | 

*LOSesApi* | [**api_v1_loses_retrieve**](docs/LOSesApi.md#api_v1_loses_retrieve) | **GET** /api/v1/loses/{id}/ | 

*LOSesApi* | [**api_v1_loses_update**](docs/LOSesApi.md#api_v1_loses_update) | **PUT** /api/v1/loses/{id}/ | 

*LegacyQueryFormApi* | [**api_v1_query_buildings_list**](docs/LegacyQueryFormApi.md#api_v1_query_buildings_list) | **GET** /api/v1/query/buildings/ | Query & filter based on Building attributes. Results are returned as flattened spreadsheet row style output

*LegacyQueryFormApi* | [**api_v1_query_installs_list**](docs/LegacyQueryFormApi.md#api_v1_query_installs_list) | **GET** /api/v1/query/installs/ | Query & filter based on Install attributes. Results are returned as flattened spreadsheet row style output

*LegacyQueryFormApi* | [**api_v1_query_members_list**](docs/LegacyQueryFormApi.md#api_v1_query_members_list) | **GET** /api/v1/query/members/ | Query & filter based on Member attributes. Results are returned as flattened spreadsheet row style output

*LinksApi* | [**api_v1_links_create**](docs/LinksApi.md#api_v1_links_create) | **POST** /api/v1/links/ | 

*LinksApi* | [**api_v1_links_destroy**](docs/LinksApi.md#api_v1_links_destroy) | **DELETE** /api/v1/links/{id}/ | 

*LinksApi* | [**api_v1_links_list**](docs/LinksApi.md#api_v1_links_list) | **GET** /api/v1/links/ | 

*LinksApi* | [**api_v1_links_lookup_list**](docs/LinksApi.md#api_v1_links_lookup_list) | **GET** /api/v1/links/lookup/ | 

*LinksApi* | [**api_v1_links_partial_update**](docs/LinksApi.md#api_v1_links_partial_update) | **PATCH** /api/v1/links/{id}/ | 

*LinksApi* | [**api_v1_links_retrieve**](docs/LinksApi.md#api_v1_links_retrieve) | **GET** /api/v1/links/{id}/ | 

*LinksApi* | [**api_v1_links_update**](docs/LinksApi.md#api_v1_links_update) | **PUT** /api/v1/links/{id}/ | 

*MembersApi* | [**api_v1_members_create**](docs/MembersApi.md#api_v1_members_create) | **POST** /api/v1/members/ | 

*MembersApi* | [**api_v1_members_destroy**](docs/MembersApi.md#api_v1_members_destroy) | **DELETE** /api/v1/members/{id}/ | 

*MembersApi* | [**api_v1_members_list**](docs/MembersApi.md#api_v1_members_list) | **GET** /api/v1/members/ | 

*MembersApi* | [**api_v1_members_lookup_list**](docs/MembersApi.md#api_v1_members_lookup_list) | **GET** /api/v1/members/lookup/ | 

*MembersApi* | [**api_v1_members_partial_update**](docs/MembersApi.md#api_v1_members_partial_update) | **PATCH** /api/v1/members/{id}/ | 

*MembersApi* | [**api_v1_members_retrieve**](docs/MembersApi.md#api_v1_members_retrieve) | **GET** /api/v1/members/{id}/ | 

*MembersApi* | [**api_v1_members_update**](docs/MembersApi.md#api_v1_members_update) | **PUT** /api/v1/members/{id}/ | 

*NodesApi* | [**api_v1_nodes_create**](docs/NodesApi.md#api_v1_nodes_create) | **POST** /api/v1/nodes/ | 

*NodesApi* | [**api_v1_nodes_destroy**](docs/NodesApi.md#api_v1_nodes_destroy) | **DELETE** /api/v1/nodes/{id}/ | 

*NodesApi* | [**api_v1_nodes_destroy2**](docs/NodesApi.md#api_v1_nodes_destroy2) | **DELETE** /api/v1/nodes/{network_number}/ | 

*NodesApi* | [**api_v1_nodes_list**](docs/NodesApi.md#api_v1_nodes_list) | **GET** /api/v1/nodes/ | 

*NodesApi* | [**api_v1_nodes_lookup_list**](docs/NodesApi.md#api_v1_nodes_lookup_list) | **GET** /api/v1/nodes/lookup/ | 

*NodesApi* | [**api_v1_nodes_partial_update**](docs/NodesApi.md#api_v1_nodes_partial_update) | **PATCH** /api/v1/nodes/{id}/ | 

*NodesApi* | [**api_v1_nodes_partial_update2**](docs/NodesApi.md#api_v1_nodes_partial_update2) | **PATCH** /api/v1/nodes/{network_number}/ | 

*NodesApi* | [**api_v1_nodes_retrieve**](docs/NodesApi.md#api_v1_nodes_retrieve) | **GET** /api/v1/nodes/{id}/ | 

*NodesApi* | [**api_v1_nodes_retrieve2**](docs/NodesApi.md#api_v1_nodes_retrieve2) | **GET** /api/v1/nodes/{network_number}/ | 

*NodesApi* | [**api_v1_nodes_update**](docs/NodesApi.md#api_v1_nodes_update) | **PUT** /api/v1/nodes/{id}/ | 

*NodesApi* | [**api_v1_nodes_update2**](docs/NodesApi.md#api_v1_nodes_update2) | **PUT** /api/v1/nodes/{network_number}/ | 

*SectorsApi* | [**api_v1_sectors_create**](docs/SectorsApi.md#api_v1_sectors_create) | **POST** /api/v1/sectors/ | 

*SectorsApi* | [**api_v1_sectors_destroy**](docs/SectorsApi.md#api_v1_sectors_destroy) | **DELETE** /api/v1/sectors/{id}/ | 

*SectorsApi* | [**api_v1_sectors_list**](docs/SectorsApi.md#api_v1_sectors_list) | **GET** /api/v1/sectors/ | 

*SectorsApi* | [**api_v1_sectors_lookup_list**](docs/SectorsApi.md#api_v1_sectors_lookup_list) | **GET** /api/v1/sectors/lookup/ | 

*SectorsApi* | [**api_v1_sectors_partial_update**](docs/SectorsApi.md#api_v1_sectors_partial_update) | **PATCH** /api/v1/sectors/{id}/ | 

*SectorsApi* | [**api_v1_sectors_retrieve**](docs/SectorsApi.md#api_v1_sectors_retrieve) | **GET** /api/v1/sectors/{id}/ | 

*SectorsApi* | [**api_v1_sectors_update**](docs/SectorsApi.md#api_v1_sectors_update) | **PUT** /api/v1/sectors/{id}/ | 

*UserFormsApi* | [**api_v1_join_create**](docs/UserFormsApi.md#api_v1_join_create) | **POST** /api/v1/join/ | Register a new request for a potential mesh Install. Used by the join form posted on the nycmesh.net website

*UserFormsApi* | [**api_v1_nn_assign_create**](docs/UserFormsApi.md#api_v1_nn_assign_create) | **POST** /api/v1/nn-assign/ | Assign a network number to a given Install object. Used by the NN Assignment form

*WebsiteMapDataApi* | [**api_v1_mapdata_kiosks_retrieve**](docs/WebsiteMapDataApi.md#api_v1_mapdata_kiosks_retrieve) | **GET** /api/v1/mapdata/kiosks/ | Proxy for the city of new york LinkNYC kisok location dataset. Output in a JSON format that is compatible with the website map. (Warning: This endpoint is a legacy format and may be deprecated/removed in the future)

*WebsiteMapDataApi* | [**api_v1_mapdata_links_list**](docs/WebsiteMapDataApi.md#api_v1_mapdata_links_list) | **GET** /api/v1/mapdata/links/ | Complete list of all Links, unpaginated, in the format expected by the website map. (Warning: This endpoint is a legacy format and may be deprecated/removed in the future)

*WebsiteMapDataApi* | [**api_v1_mapdata_nodes_list**](docs/WebsiteMapDataApi.md#api_v1_mapdata_nodes_list) | **GET** /api/v1/mapdata/nodes/ | Complete list of all \"Nodes\" (mostly Installs with some fake installs generated to solve NN re-use), unpaginated, in the format expected by the website map. (Warning: This endpoint is a legacy format and may be deprecated/removed in the future)

*WebsiteMapDataApi* | [**api_v1_mapdata_sectors_list**](docs/WebsiteMapDataApi.md#api_v1_mapdata_sectors_list) | **GET** /api/v1/mapdata/sectors/ | Complete list of all Sectors, unpaginated, in the format expected by the website map. (Warning: This endpoint is a legacy format and may be deprecated/removed in the future)

## Documentation For Models

 - [AccessPoint](docs/AccessPoint.md)

 - [AccessPointLinksFromInner](docs/AccessPointLinksFromInner.md)

 - [AccessPointNode](docs/AccessPointNode.md)

 - [AddressTruthSourcesEnum](docs/AddressTruthSourcesEnum.md)

 - [BlankEnum](docs/BlankEnum.md)

 - [Building](docs/Building.md)

 - [BuildingInstallsInner](docs/BuildingInstallsInner.md)

 - [BuildingNodesInner](docs/BuildingNodesInner.md)

 - [BuildingPrimaryNode](docs/BuildingPrimaryNode.md)

 - [CityErrorResponse](docs/CityErrorResponse.md)

 - [Device](docs/Device.md)

 - [ErrorResponse](docs/ErrorResponse.md)

 - [ErrorResponseInternalFailure](docs/ErrorResponseInternalFailure.md)

 - [ErrorResponseInvalidAddr](docs/ErrorResponseInvalidAddr.md)

 - [ErrorResponseMissingFields](docs/ErrorResponseMissingFields.md)

 - [GeocodeSuccessResponse](docs/GeocodeSuccessResponse.md)

 - [Install](docs/Install.md)

 - [InstallBuilding](docs/InstallBuilding.md)

 - [InstallMember](docs/InstallMember.md)

 - [InstallNode](docs/InstallNode.md)

 - [JoinFormRequest](docs/JoinFormRequest.md)

 - [JoinFormSuccessResponse](docs/JoinFormSuccessResponse.md)

 - [KioskData](docs/KioskData.md)

 - [LOS](docs/LOS.md)

 - [LOSFromBuilding](docs/LOSFromBuilding.md)

 - [Link](docs/Link.md)

 - [LinkFromDevice](docs/LinkFromDevice.md)

 - [LinkStatusEnum](docs/LinkStatusEnum.md)

 - [LinkType](docs/LinkType.md)

 - [LinkTypeEnum](docs/LinkTypeEnum.md)

 - [MapDataInstall](docs/MapDataInstall.md)

 - [MapDataLink](docs/MapDataLink.md)

 - [MapDataSector](docs/MapDataSector.md)

 - [Member](docs/Member.md)

 - [NNFormSuccessResponse](docs/NNFormSuccessResponse.md)

 - [NetworkNumberAssignmentRequest](docs/NetworkNumberAssignmentRequest.md)

 - [Node](docs/Node.md)

 - [NodeBuildingsInner](docs/NodeBuildingsInner.md)

 - [NodeDevicesInner](docs/NodeDevicesInner.md)

 - [NodeEdit](docs/NodeEdit.md)

 - [NullEnum](docs/NullEnum.md)

 - [PaginatedAccessPointList](docs/PaginatedAccessPointList.md)

 - [PaginatedBuildingList](docs/PaginatedBuildingList.md)

 - [PaginatedDeviceList](docs/PaginatedDeviceList.md)

 - [PaginatedInstallList](docs/PaginatedInstallList.md)

 - [PaginatedLOSList](docs/PaginatedLOSList.md)

 - [PaginatedLinkList](docs/PaginatedLinkList.md)

 - [PaginatedMemberList](docs/PaginatedMemberList.md)

 - [PaginatedNodeList](docs/PaginatedNodeList.md)

 - [PaginatedQueryFormList](docs/PaginatedQueryFormList.md)

 - [PaginatedSectorList](docs/PaginatedSectorList.md)

 - [PatchedAccessPoint](docs/PatchedAccessPoint.md)

 - [PatchedBuilding](docs/PatchedBuilding.md)

 - [PatchedDevice](docs/PatchedDevice.md)

 - [PatchedInstall](docs/PatchedInstall.md)

 - [PatchedLOS](docs/PatchedLOS.md)

 - [PatchedLink](docs/PatchedLink.md)

 - [PatchedMember](docs/PatchedMember.md)

 - [PatchedNodeEdit](docs/PatchedNodeEdit.md)

 - [PatchedSector](docs/PatchedSector.md)

 - [QueryForm](docs/QueryForm.md)

 - [Sector](docs/Sector.md)

 - [SourceEnum](docs/SourceEnum.md)

 - [Status195Enum](docs/Status195Enum.md)

 - [Status2a6Enum](docs/Status2a6Enum.md)

 - [Status432Enum](docs/Status432Enum.md)

 - [TypeB10Enum](docs/TypeB10Enum.md)



## Documentation For Authorization

Authentication schemes defined for the API:



### Session ID

- **Type**: API key

- **API key parameter name**: sessionid

- **Location**: 



### tokenAuth

- **Type**: API key

- **API key parameter name**: Authorization

- **Location**: HTTP header

## Author