Metadata-Version: 2.1
Name: niapi
Version: 0.3.0
Summary: Network Data API
Home-page: https://github.com/JacobCoffee/niapi
License: MIT
Keywords: niapi,network,api,tool,rest,http,asgi,pydantic,litestar,starlite,websocket
Author: Jacob Coffee
Author-email: jacob@z7x.org
Maintainer: Jacob Coffee
Maintainer-email: jacob@z7x.org
Requires-Python: >=3.11,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: AsyncIO
Classifier: Framework :: Pydantic
Classifier: Framework :: Pydantic :: 1
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development
Classifier: Topic :: System :: Networking
Classifier: Typing :: Typed
Requires-Dist: litestar[prometheus,standard,structlog] (==2.0b2)
Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
Project-URL: Changelog, https://github.com/JacobCoffee/niapi/releases/
Project-URL: Documentation, https://jacobcoffee.github.io/niapi/index.html
Project-URL: Issue Tracker, https://github.com/JacobCoffee/niapi/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
Project-URL: Repository, https://github.com/JacobCoffee/niapi
Project-URL: Reddit, https://www.reddit.com/u/monorepo
Project-URL: Twitter, https://twitter.com/_scriptr
Description-Content-Type: text/markdown

<!-- markdownlint-disable -->
<p align="center">
  <img src="https://github.com/JacobCoffee/niapi/blob/a82a86a1b8ca90f3c66a080291cfd074efcbfd1a/docs/images/PNG/Transparent/logo.png" alt="NIAPI Logo - Light" width="100%" height="auto" />
</p>
<!-- markdownlint-restore -->

<div align="center">

<!-- prettier-ignore-start -->

| Project   |     | Status                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|-----------|:----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| CI/CD     |     | [![Latest Release](https://github.com/JacobCoffee/niapi/actions/workflows/publish.yaml/badge.svg)](https://github.com/JacobCoffee/niapi/actions/workflows/publish.yaml) [![ci](https://github.com/JacobCoffee/niapi/actions/workflows/ci.yaml/badge.svg)](https://github.com/JacobCoffee/niapi/actions/workflows/ci.yaml) [![Documentation Building](https://github.com/JacobCoffee/niapi/actions/workflows/docs.yaml/badge.svg)](https://github.com/JacobCoffee/niapi/actions/workflows/docs.yaml) [![CodeQL](https://github.com/JacobCoffee/niapi/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/JacobCoffee/niapi/actions/workflows/github-code-scanning/codeql)                                                                                                                                                                                                                                                                                                                                                                        |
| Package   |     | [![PyPI - Version](https://img.shields.io/pypi/v/niapi)](https://badge.fury.io/py/niapi) ![PyPI - Support Python Versions](https://img.shields.io/pypi/pyversions/niapi)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Quality   |     | [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=jacobcoffee_niapi&metric=coverage)](https://sonarcloud.io/summary/new_code?id=jacobcoffee_niapi) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=jacobcoffee_niapi&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=jacobcoffee_niapi) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=jacobcoffee_niapi&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=jacobcoffee_niapi) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=jacobcoffee_niapi&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=jacobcoffee_niapi) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=jacobcoffee_niapi&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=jacobcoffee_niapi) [![Known Vulnerabilities](https://snyk.io/test/github/JacobCoffee/niapi/badge.svg)](https://snyk.io/test/github/JacobCoffee/niapi) |
| Community |     | [![Twitter](https://img.shields.io/twitter/follow/_scriptr?style=social&logo=twitter)](https://twitter.com/_scriptr)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Meta      |     | [![Litestar Framework](https://img.shields.io/badge/Litestar%20Framework-%E2%AD%90%20Litestar-202235.svg)](https://github.com/JacobCoffee/niapi) [![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![code style - Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![types - Mypy](https://img.shields.io/badge/types-Mypy-202235.svg)](https://github.com/python/mypy) [![License - MIT](https://img.shields.io/badge/license-MIT-202235.svg)](https://spdx.org/licenses/) [![GitHub Sponsors](https://img.shields.io/github/sponsors/JacobCoffee?logo=GitHub%20Sponsors&style=social)](https://github.com/sponsors/JacobCoffee)                                                                                                                                                                                                                                                            |

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-113-202235.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- prettier-ignore-end -->

</div>

# `niapi` - Network Information API

[//]: # "TODO"

## Table of Contents

- [About](#about)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [Contributors](#contributors)
- [License](#license)
- [Acknowledgements](#acknowledgements)
- [Screenshots](#screenshots)

## About

[//]: # "TODO"

## Installation

```console
pip install niapi
```

## Usage

[//]: # "TODO"

Install the package with `pip`:

```console
pip install niapi
```

Using the CLI:

```python
# todo
```

Using the API

```python
# todo
```

## Contributing

See [CONTRIBUTING.rst](../CONTRIBUTING.rst) for more information.

Start the app:

```console
app run-all
```

Start the TailwindCSS watcher:

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

## Contributors

[//]: # "TODO"

## License

[MIT](LICENSE)

## Acknowledgements

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

## Screenshots

[//]: # "TODO"

![home.png](images/index.png)
![home-dark.png](images/index-dark.png)

