Description:

niapi 0.5.0

Project

Status




CI/CD




Package




Quality




Community




Meta








niapi - Network Information API
Table of Contents

About
Installation
Usage
Contributing
Contributors
License
Acknowledgements
Screenshots

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 curl
➜ curl --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

Browse to:

Swagger
Elements


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

Built on Litestar and Pydantic
Using https://feathericons.dev/
Using TailwindCSS

Screenshots

License

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Share

• Share on Facebook
• Share on Twitter