apiman
Api document support for any python web framework
File Explorer
Download Latest Version (.zip)- test-and-release.yml
- index.html
- openapi2_schema.json
- openapi3.0_schema.yaml
- openapi3.1_schema.yaml
- redoc.html
- swagger.html
- template.yaml
- __init__.py
- base.py
- bottle.py
- django.py
- falcon.py
- flask.py
- starlette.py
- tornado.py
- development.md
- frameworks.md
- getting-started.md
- index.md
- request-validation.md
- specifications.md
- SwaggerUI.jpg
- __init__.py
- asgi.py
- settings.py
- test.py
- urls.py
- views.py
- wsgi.py
- manage.py
- cat_template.yml
- cats_get.yml
- cats_post.json
- dog_template.yml
- dogs_get.yml
- dogs_post.json
- __init__.py
- _bottle.py
- _falcon.py
- _flask.py
- _starlette.py
- _tornado.py
- release_decision.py
- __init__.py
- test_adapters.py
- test_base.py
- test_examples.py
- test_release_decision.py
- .flake8
- .gitignore
- LICENSE
- Makefile
- MANIFEST.in
- mkdocs.yml
- noxfile.py
- pyproject.toml
- pytest.ini
- README.md
# Installation Guide
git clone https://github.com/strongbugman/apiman
Downloads the entire project code from GitHub to your computer.
cd apiman
Moves into the project folder you just downloaded.
2. Official Install Script
Easy Recommended- Python 3 Python is required to use pip.
pip install -U apiman
Installs the package published on PyPI directly โ no need to clone the source.
pip install starlette uvicorn
Installs the package published on PyPI directly โ no need to clone the source.
Pulled directly from this repo's README.
3. Python
Easypip install -U apiman
Installs the package published on PyPI directly โ no need to clone the source.
pip install starlette uvicorn
Installs the package published on PyPI directly โ no need to clone the source.
Pulled directly from this repo's README.
4. Make
Medium- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make docs
Compiles the code based on the generated build configuration to produce an executable.
make install # create/sync .venv
Compiles the code based on the generated build configuration to produce an executable.
make lint # Ruff + mypy
Compiles the code based on the generated build configuration to produce an executable.
make test # lint + tests + coverage
Compiles the code based on the generated build configuration to produce an executable.
make test-all # Python 3.9-3.12 via Nox
Compiles the code based on the generated build configuration to produce an executable.
Pulled directly from this repo's README.