niapi

| Project | | Status | |-----------|:----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | CI/CD | | [](https://github.com/JacobCoffee/niapi/actions/workflows/publish.yaml) [](https://github.com/JacobCoffee/niapi/actions/workflows/ci.yaml) [](https://github.com/JacobCoffee/niapi/actions/workflows/docs.yaml) [](https://github.com/JacobCoffee/niapi/actions/workflows/github-code-scanning/codeql) | | Package | | [](https://badge.fury.io/py/niapi)  | | Quality | | [](https://codecov.io/gh/JacobCoffee/niapi) [](https://sonarcloud.io/summary/new_code?id=JacobCoffee_niapi) [](https://sonarcloud.io/summary/new_code?id=JacobCoffee_niapi) [](https://sonarcloud.io/summary/new_code?id=JacobCoffee_niapi) [](https://sonarcloud.io/summary/new_code?id=JacobCoffee_niapi) [](https://sonarcloud.io/summary/new_code?id=JacobCoffee_niapi) [](https://snyk.io/test/github/JacobCoffee/niapi) | | Community | | [](https://twitter.com/_scriptr) | | Meta | | [](https://github.com/JacobCoffee/niapi) [](https://github.com/astral-sh/ruff) [](https://github.com/psf/black) [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/sponsors/JacobCoffee) | [](https://sonarcloud.io/summary/new_code?id=JacobCoffee_niapi)

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

1. Browse to:
   • Swagger Web or Swagger Localhost
   • Elements or Elements Localhost
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

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

Screenshots

This site is open source. Improve this page.