Data

Tools

Indexes

Applications

Experiments

Open Source Science

readyapi-cli

https://github.com/readyapi/readyapi-cli

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.5%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: readyapi
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 118 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 6
  • Releases: 5
Created almost 2 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing Funding License Citation Security

README.md

ReadyAPI CLI

Test Publish Coverage Package version

Source Code: https://github.com/readyapi/readyapi-cli

Run and manage ReadyAPI apps from the command line with ReadyAPI CLI. 🚀

Description

ReadyAPI CLI is a command line program readyapi that you can use to serve your ReadyAPI app, manage your ReadyAPI project, and more.

When you install ReadyAPI (e.g. with pip install "readyapi[standard]"), it includes a package called readyapi-cli, this package provides the readyapi command in the terminal.

To run your ReadyAPI app for development, you can use the readyapi dev command:

```console $ readyapi dev main.py INFO Using path main.py INFO Resolved absolute path /home/user/code/awesomeapp/main.py INFO Searching for package file structure from directories with __init__.py files INFO Importing from /home/user/code/awesomeapp ╭─ Python module file ─╮ │ │ │ 🐍 main.py │ │ │ ╰──────────────────────╯ INFO Importing module main INFO Found importable ReadyAPI app ╭─ Importable ReadyAPI app ─╮ │ │ │ from main import app │ │ │ ╰──────────────────────────-╯ INFO Using import string main:app ╭────────── ReadyAPI CLI - Development mode ──────────╮ │ │ │ Serving at: http://127.0.0.1:8000 │ │ │ │ API docs: http://127.0.0.1:8000/docs │ │ │ │ Running in development mode, for production use: │ │ │ │ readyapi run │ │ │ ╰─────────────────────────────────────────────────────╯ INFO: Will watch for changes in these directories: ['/home/user/code/awesomeapp'] INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) INFO: Started reloader process [56345] using WatchFiles INFO: Started server process [56352] INFO: Waiting for application startup. INFO: Application startup complete. ```

That command line program called readyapi is ReadyAPI CLI.

ReadyAPI CLI takes the path to your Python program and automatically detects the variable with the ReadyAPI (commonly named app) and how to import it, and then serves it.

For production you would use readyapi run instead. 🚀

Internally, ReadyAPI CLI uses Uvicorn, a high-performance, production-ready, ASGI server. 😎

readyapi dev

When you run readyapi dev, it will run on development mode.

By default, it will have auto-reload enabled, so it will automatically reload the server when you make changes to your code. This is resource intensive and could be less stable than without it, you should only use it for development.

By default it will listen on the IP address 127.0.0.1, which is the IP for your machine to communicate with itself alone (localhost).

readyapi run

When you run readyapi run, it will run on production mode by default.

It will have auto-reload disabled by default.

It will listen on the IP address 0.0.0.0, which means all the available IP addresses, this way it will be publicly accessible to anyone that can communicate with the machine. This is how you would normally run it in production, for example, in a container.

In most cases you would (and should) have a "termination proxy" handling HTTPS for you on top, this will depend on how you deploy your application, your provider might do this for you, or you might need to set it up yourself. You can learn more about it in the ReadyAPI Deployment documentation.

License

This project is licensed under the terms of the MIT license.

Owner

  • Name: ReadyAPI
  • Login: readyapi
  • Kind: organization
  • Email: infosulaiman@icloud.com

Open / Source / Insights

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: ReadyAPI CLI
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: KhulnaSoft
    family-names: DevOps
    email: info@khulnasoft.com
identifiers:
repository-code: 'https://github.com/readyapi/readyapi-cli'
url: 'https://readyapi.khulnasoft.com'
abstract: >-
  Run and manage ReadyAPI apps from the command line with ReadyAPI CLI. 🚀
keywords:
  - readyapi
  - cligenius
  - readyapi-cli
license: MIT

GitHub Events

Total
  • Delete event: 9
  • Issue comment event: 37
  • Push event: 19
  • Pull request event: 25
  • Fork event: 1
  • Create event: 10
Last Year
  • Delete event: 9
  • Issue comment event: 37
  • Push event: 19
  • Pull request event: 25
  • Fork event: 1
  • Create event: 10

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 78
  • Average time to close issues: N/A
  • Average time to close pull requests: 14 days
  • Total issue authors: 0
  • Total pull request authors: 5
  • Average comments per issue: 0
  • Average comments per pull request: 0.76
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 55
Past Year
  • Issues: 0
  • Pull requests: 45
  • Average time to close issues: N/A
  • Average time to close pull requests: 7 days
  • Issue authors: 0
  • Pull request authors: 5
  • Average comments per issue: 0
  • Average comments per pull request: 0.93
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 38
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (75)
  • gitworkflows (21)
  • NxPKG (8)
  • pre-commit-ci[bot] (2)
  • khulnasoft-bot (2)
Top Labels
Issue Labels
Pull Request Labels
dependencies (74) python (53) github_actions (21) upgrade (2) approved-2 (2) enhancement (2) refactor (2) internal (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 3,411 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 7
  • Total maintainers: 1
pypi.org: readyapi-cli-slim

Run and manage ReadyAPI apps from the command line with ReadyAPI CLI. 🚀

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 10 Last month
Rankings
Dependent packages count: 9.4%
Average: 35.7%
Dependent repos count: 62.0%
Maintainers (1)
nextlinux
Last synced: 6 months ago
pypi.org: readyapi-cli

Run and manage ReadyAPI apps from the command line with ReadyAPI CLI. 🚀

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 3,401 Last month
Rankings
Dependent packages count: 9.4%
Forks count: 32.9%
Average: 36.7%
Stargazers count: 42.6%
Dependent repos count: 62.0%
Maintainers (1)
nextlinux
Last synced: 6 months ago

Dependencies

.github/workflows/issue-manager.yml actions
  • khulnasoft/issue-manager-action 0.5.0 composite
.github/workflows/latest-changes.yml actions
  • actions/checkout v4 composite
  • docker://khulnasoft/latest-changes latest composite
  • mxschmitt/action-tmate v3 composite
.github/workflows/publish.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • pypa/gh-action-pypi-publish v1.8.14 composite
.github/workflows/smokeshow.yml actions
  • actions/setup-python v5 composite
  • dawidd6/action-download-artifact v3.1.4 composite
.github/workflows/test-redistribute.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/test.yml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v3 composite
  • mxschmitt/action-tmate v3 composite
  • re-actors/alls-green release/v1 composite
pyproject.toml pypi
  • typer >= 0.12.3
requirements-tests.txt pypi
  • coverage >=6.2,<8.0 test
  • mypy ==1.10.0 test
  • pytest >=4.4.0,<9.0.0 test
  • readyapi-slim * test
  • ruff ==0.4.3 test
  • uvicorn * test
requirements.txt pypi
  • pre-commit >=2.17.0,<4.0.0
.github/workflows/add-to-project.yml actions
  • actions/add-to-project v1.0.2 composite
.github/workflows/labeler.yml actions
  • actions/labeler v5 composite
  • docker://agilepathway/pull-request-label-checker latest composite