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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

niapi-0.5.0.tar.gz (92.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

niapi-0.5.0-py3-none-any.whl (98.8 kB view details)

Uploaded Python 3

File details

Details for the file niapi-0.5.0.tar.gz.

File metadata

  • Download URL: niapi-0.5.0.tar.gz
  • Upload date:
  • Size: 92.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Linux/5.15.0-1041-azure

File hashes

Hashes for niapi-0.5.0.tar.gz
Algorithm Hash digest
SHA256 c9528843b45328ab8a73201ef06bddb6adb199633338be029ce991c6b79595ce
MD5 bccf7db03d10223f93fc9aad2c19d310
BLAKE2b-256 c801850dcc9104fccdc789031369529a85f5280928f99044e9347334991a313d

See more details on using hashes here.

File details

Details for the file niapi-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: niapi-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 98.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Linux/5.15.0-1041-azure

File hashes

Hashes for niapi-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3fc4a3cfb61e3d75fc103eb1369ebabbd5ce2cd20a3758ec719efd2ba6d2e5b7
MD5 1793398791e90257ab890e1204cc8549
BLAKE2b-256 96fbb315388b70edc35cc31138ddeb1417084e632a2f6f8e8a4f5f9b3a1af7cb

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.5.0 This release

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page