piccolo_api
ASGI middleware for authentication, rate limiting, and building REST endpoints.
File Explorer
Download Latest Version (.zip)- codeql.yml
- release.yaml
- tests.yaml
- .gitkeep
- index.rst
- index.rst
- change_password.png
- index.rst
- index.rst
- index.rst
- hooks.rst
- index.rst
- piccolo_crud.rst
- serializers.rst
- index.rst
- index.rst
- introduction.rst
- prevention_measures.rst
- usage.rst
- index.rst
- introduction.rst
- providers.rst
- fastapi_screenshot.png
- index.rst
- example.py
- endpoints.rst
- example.rst
- index.rst
- introduction.rst
- middleware.rst
- mfa_register_endpoint.jpg
- endpoints.rst
- example.rst
- index.rst
- introduction.rst
- providers.rst
- tables.rst
- index.rst
- piccolo_admin_screenshot.png
- index.rst
- index.rst
- register_template.png
- endpoints.rst
- index.rst
- example.py
- login_template.png
- logout_template.png
- commands.rst
- endpoints.rst
- example.rst
- index.rst
- introduction.rst
- middleware.rst
- tables.rst
- app.py
- main.py
- tables.py
- example.py
- authorize_button.png
- authorize_modal.png
- endpoints.rst
- example.rst
- index.rst
- introduction.rst
- middleware.rst
- tables.rst
- index.rst
- conf.py
- index.rst
- logo.png
- logo_hero.png
- make.bat
- Makefile
- __init__.py
- conftest.py
- pages.py
- test_mfa.py
- app.py
- main.py
- piccolo_conf.py
- README.md
- requirements.txt
- home.html
- app.py
- main.py
- piccolo_conf.py
- README.md
- requirements.txt
- app.py
- main.py
- piccolo_conf.py
- README.md
- requirements.txt
- __init__.py
- __init__.py
- endpoints.py
- __init__.py
- endpoints.py
- exceptions.py
- hooks.py
- serializers.py
- validators.py
- __init__.py
- middleware.py
- __init__.py
- middleware.py
- __init__.py
- providers.py
- __init__.py
- endpoints.py
- __init__.py
- endpoints.py
- middleware.py
- __init__.py
- base.py
- content_type.py
- local.py
- s3.py
- __init__.py
- mfa_authenticator_2024_08_08t21_41_46_837552.py
- __init__.py
- piccolo_app.py
- provider.py
- tables.py
- utils.py
- __init__.py
- endpoints.py
- provider.py
- README.md
- recovery_codes.py
- swagger_ui.html.jinja
- __init__.py
- endpoints.py
- __init__.py
- middleware.py
- __init__.py
- endpoints.py
- __init__.py
- session_auth_2019_11_12t20_47_17.py
- session_auth_2026_05_27t16_15_06_677127.py
- __init__.py
- commands.py
- endpoints.py
- middleware.py
- piccolo_app.py
- tables.py
- __init__.py
- captcha.py
- excluded_paths.py
- hooks.py
- junction.py
- styles.py
- user.py
- __init__.py
- junction.py
- __init__.py
- base.html
- change_password.html
- mfa_authenticator_setup.html
- mfa_cancel.html
- mfa_disabled.html
- mfa_setup.html
- register.html
- session_login.html
- session_logout.html
- 2019-11-18T22-24-41.py
- __init__.py
- __init__.py
- endpoints.py
- middleware.py
- piccolo_app.py
- tables.py
- __init__.py
- types.py
- __init__.py
- py.typed
- authenticator.txt
- cryptography.txt
- pynacl.txt
- s3.txt
- dev-requirements.txt
- doc-requirements.txt
- e2e-requirements.txt
- README.md
- readthedocs-requirements.txt
- requirements.txt
- test-requirements.txt
- lint.sh
- README.md
- release.sh
- run-docs.sh
- run-e2e-test.sh
- test-postgres.sh
- test-sqlite.sh
- test_change_password.py
- test_crud_endpoints.py
- test_custom_pk.py
- test_hooks.py
- test_validators.py
- test_csp.py
- test_csrf.py
- test_fastapi_endpoints.py
- test_jwt_endpoints.py
- test_jwt_middleware.py
- bulb.jpg
- test_base.py
- test_local.py
- test_s3.py
- test_tables.py
- test_mfa_endpoints.py
- test_recovery_codes.py
- test_openapi_endpoints.py
- test_rate_middleware.py
- test_register.py
- base.html
- login.html
- login.html
- test_session.py
- test_captcha.py
- test_styles.py
- test_user.py
- test_endpoints.py
- test_middleware.py
- test_types.py
- __init__.py
- postgres_conf.py
- serve.py
- sqlite_conf.py
- .flake8
- .gitignore
- .readthedocs.yaml
- CHANGES.rst
- CONTRIBUTING.md
- LICENSE
- pyproject.toml
- README.md
- setup.py
# Installation Guide
1. Get the code
git clone https://github.com/piccolo-orm/piccolo_api
Downloads the entire project code from GitHub to your computer.
cd piccolo_api
Moves into the project folder you just downloaded.
2. Python
Easy RecommendedPrerequisites
pip install -r example_projects/change_password_demo/requirements.txt
Installs the Python libraries listed in requirements.txt (or similar).
python <μ€νν νμΌλͺ
>.py # READMEμμ μ νν μ€ν νμΌλͺ
μ νμΈνμΈμ
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
// repository documentation
Was this content helpful?
(0 ratings)