Skip to content

Commit

Permalink
docs: attempt to make pypi work
Browse files Browse the repository at this point in the history
  • Loading branch information
@JacobCoffee
JacobCoffee committed Jun 25, 2023
1 parent 79eada1 commit 515ccff
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions docs/PYPI_README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- 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" />
<img src="https://github.com/JacobCoffee/niapi/blob/a82a86a1b8ca90f3c66a080291cfd074efcbfd1a/docs/images/PNG/Transparent/logo.png?raw=True" alt="NIAPI Logo - Light" width="100%" height="auto" />
</p>
<!-- markdownlint-restore -->

Expand All @@ -9,12 +9,16 @@
<!-- 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) |
| 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) |
| Meta | | [![Litestar Framework](https://img.shields.io/badge/Litestar%20Framework-%E2%AD%90%20Litestar-85c7f2.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-85c7f2.svg)](https://github.com/python/mypy) [![License - MIT](https://img.shields.io/badge/license-MIT-85c7f2.svg)](https://spdx.org/licenses/) [![GitHub Sponsors](https://img.shields.io/github/sponsors/JacobCoffee?logo=GitHub%20Sponsors&style=social)](https://github.com/sponsors/JacobCoffee) |

[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-white.svg)](https://sonarcloud.io/summary/new_code?id=JacobCoffee_niapi)

<!-- prettier-ignore-end -->

</div>

Expand Down Expand Up @@ -67,7 +71,7 @@ Using the API

## Contributing

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

Start the app:

Expand Down Expand Up @@ -99,5 +103,5 @@ tailwindcss -i niapi/domain/web/resources/input.css -o niapi/domain/web/resource

[//]: # "TODO"

![home.png](images/index.png)
![home-dark.png](images/index-dark.png)
![](https://github.com/JacobCoffee/niapi/blob/79eada17e1477feae3f3e15106331e4b81625157/docs/images/index-dark.png?raw=true)
![](https://github.com/JacobCoffee/niapi/blob/79eada17e1477feae3f3e15106331e4b81625157/docs/images/index.png?raw=true)

0 comments on commit 515ccff

Please sign in to comment.