Skip to main content

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 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:
  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

Metadata

Release files for niapi 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for niapi 0.5.0
File Size Uploaded
niapi-0.5.0.tar.gz 92.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for niapi 0.5.0
File Interpreter ABI Platform
niapi-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 190.9 kB

Release files / niapi-0.5.0.tar.gz

Download URL niapi-0.5.0.tar.gz
Size 92.1 kB
Tags Source
SHA-256 checksum
How to use checksums
c9528843b45328ab8a73201ef06bddb6adb199633338be029ce991c6b79595ce
BLAKE2b-256 checksum
How to use checksums
c801850dcc9104fccdc789031369529a85f5280928f99044e9347334991a313d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.11.4 Linux/5.15.0-1041-azure

Release files / niapi-0.5.0-py3-none-any.whl

Download URL niapi-0.5.0-py3-none-any.whl
Size 98.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3fc4a3cfb61e3d75fc103eb1369ebabbd5ce2cd20a3758ec719efd2ba6d2e5b7
BLAKE2b-256 checksum
How to use checksums
96fbb315388b70edc35cc31138ddeb1417084e632a2f6f8e8a4f5f9b3a1af7cb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.11.4 Linux/5.15.0-1041-azure

Release history Release notifications | RSS feed

This release

0.5.0 This release

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page