Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jcf/slither
Taking Pythons from one machine to another
https://github.com/jcf/slither
Last synced: 1 day ago
JSON representation
Taking Pythons from one machine to another
- Host: GitHub
- URL: https://github.com/jcf/slither
- Owner: jcf
- Created: 2024-05-08T14:03:35.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-05-10T19:09:43.000Z (6 months ago)
- Last Synced: 2024-05-11T10:51:52.694Z (6 months ago)
- Language: Python
- Homepage: https://slither.byinvetica.co.uk/docs
- Size: 125 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.org
Awesome Lists containing this project
README
#+title: Slither
FastAPI is a popular solution for building APIs in Python, especially when
wrapping the creativity of data scientists.
* Contents :TOC:
- [[#whats-in-the-box][What's in the box?]]
- [[#bin-scripts][Bin scripts]]
- [[#api][API]]
- [[#dependencies][Dependencies]]
- [[#development][Development]]
- [[#installing-dependencies][Installing dependencies]]
- [[#running-the-api][Running the API]]
- [[#running-tests][Running tests]]
* What's in the box?
** Bin scripts
- =bin/setup=: Prepare your local environment for work
- =bin/dev=: Start a prepared development environment
- =bin/fmt=: Automatically format code
- =bin/test=: Run tests
** API
We have a set of routers with a simple test using =pytest=, LSP support via
=pyright=, and some minimal validation using Pydantic. Next on the list would be
adding dependency injection to explore reproducibility of expensive underlying
models one might want to wrap.
#+begin_src sh :results output verbatim :exports both
tree app -I __pycache__
#+end_src
#+results:
#+begin_example
app
├── __init__.py
├── config.py
├── main.py
├── models.py
├── routers
│ ├── __init__.py
│ └── farms.py
├── test_main.py
└── test_models.py
2 directories, 8 files
#+end_example
** Dependencies
#+begin_src sh :results output verbatim
poetry show
#+end_src
#+results:
#+begin_example
annotated-types 0.6.0 Reusable constraint types to use with typing.Ann...
anyio 4.3.0 High level compatibility layer for multiple asyn...
certifi 2024.2.2 Python package for providing Mozilla's CA Bundle.
click 8.1.7 Composable command line interface toolkit
dnspython 2.6.1 DNS toolkit
email-validator 2.1.1 A robust email address syntax and deliverability...
fastapi 0.111.0 FastAPI framework, high performance, easy to lea...
fastapi-cli 0.0.2 Run and manage FastAPI apps from the command lin...
h11 0.14.0 A pure-Python, bring-your-own-I/O implementation...
httpcore 1.0.5 A minimal low-level HTTP client.
httptools 0.6.1 A collection of framework independent HTTP proto...
httpx 0.27.0 The next generation HTTP client.
idna 3.7 Internationalized Domain Names in Applications (...
iniconfig 2.0.0 brain-dead simple config-ini parsing
isort 5.13.2 A Python utility / library to sort Python imports.
jinja2 3.1.3 A very fast and expressive template engine.
markdown-it-py 3.0.0 Python port of markdown-it. Markdown parsing, do...
markupsafe 2.1.5 Safely add untrusted strings to HTML/XML markup.
mdurl 0.1.2 Markdown URL utilities
nodeenv 1.8.0 Node.js virtual environment builder
orjson 3.10.3 Fast, correct Python JSON library supporting dat...
packaging 24.0 Core utilities for Python packages
pluggy 1.5.0 plugin and hook calling mechanisms for python
pydantic 2.7.1 Data validation using Python type hints
pydantic-core 2.18.2 Core functionality for Pydantic validation and s...
pydantic-settings 2.2.1 Settings management using Pydantic
pygments 2.18.0 Pygments is a syntax highlighting package writte...
pyright 1.1.361 Command line wrapper for pyright
pytest 8.2.0 pytest: simple powerful testing with Python
python-dotenv 1.0.1 Read key-value pairs from a .env file and set th...
python-multipart 0.0.9 A streaming multipart parser for Python
pyyaml 6.0.1 YAML parser and emitter for Python
rich 13.7.1 Render rich text, tables, progress bars, syntax ...
setuptools 69.5.1 Easily download, build, install, upgrade, and un...
shellingham 1.5.4 Tool to Detect Surrounding Shell
sniffio 1.3.1 Sniff out which async library your code is runni...
starlette 0.37.2 The little ASGI library that shines.
typer 0.12.3 Typer, build great CLIs. Easy to code. Based on ...
typing-extensions 4.11.0 Backported and Experimental Type Hints for Pytho...
ujson 5.9.0 Ultra fast JSON encoder and decoder for Python
uvicorn 0.29.0 The lightning-fast ASGI server.
uvloop 0.19.0 Fast implementation of asyncio event loop on top...
watchfiles 0.21.0 Simple, modern and high performance file watchin...
websockets 12.0 An implementation of the WebSocket Protocol (RFC...
#+end_example
* Development
** Installing dependencies
#+begin_src sh :eval never
# If you're using Nix...
nix develop --override-input devenv-root "file+file://"<(printf %s "$PWD")
poetry install
#+end_src
** Running the API
With Nix, one can start a development process via =devenv=.
#+begin_src sh :eval never
devenv up
#+end_src
Or start a development FastAPI process like so:
#+begin_src sh :eval never
fastapi dev app/main.py
#+end_src
** Running tests
#+begin_src sh :results output verbatim
pytest
#+end_src
#+results:
#+begin_example
============================= test session starts ==============================
platform darwin -- Python 3.11.8, pytest-8.2.0, pluggy-1.5.0
rootdir: /Users/jcf/code/slither
configfile: pyproject.toml
plugins: anyio-4.3.0
collected 7 items
app/test_main.py . [ 14%]
app/test_models.py ...... [100%]
============================== 7 passed in 0.33s ===============================
#+end_example