niapi

Network Data API


Keywords
niapi, network, api, tool, rest, http, asgi, pydantic, litestar, starlite, websocket, python
License
MIT
Install
pip install niapi==0.5.0

Documentation

NIAPI Logo - Light NIAPI Logo - Dark

Project Status
CI/CD Latest Release ci Documentation Building CodeQL
Package PyPI - Version PyPI - Support Python Versions
Quality codecov Coverage Quality Gate Status Maintainability Rating Reliability Rating Security Rating Known Vulnerabilities
Community Twitter
Meta Litestar Framework linting - Ruff code style - Black types - Mypy License - MIT GitHub Sponsors

SonarCloud

niapi - Network Information API

Table of Contents

About

Installation

pip install niapi

Usage

Install the project:

pip install -e .

Run the project:

NOTE: From within the virtual environment

app run -r --debug

Using the CLI:

# via curlcurl --request GET \
        --url 'http://0.0.0.0:8000/calculator/ip?ip=4.8.15.16&prefix=23' \
        --header 'Content-Type: application/json'
# via App CLI
# TODO
app calculate "10.248.15.39/29"

Using the API

  1. Browse to:
  2. Use the auto-generated API docs to interact with the API

From around the web:

Browse to https://niapi.app/ and use the front page form, API, or curl to interact with the API.

Contributing

See CONTRIBUTING.rst for more information.

Start the app:

app run-all

Start the TailwindCSS watcher:

tailwindcss -i niapi/domain/web/resources/input.css -o niapi/domain/web/resources/style.css --watch

Contributors

License

MIT

Acknowledgements

Screenshots

home.png home-dark.png img.png