Clyjin
System configuration toolbox
Modules
Clyjin has set of builtin modules to work with, to call a module use:
python3 -m clyjin {module_name} {module_args}
modules.API
Module deploying web server to display OpenAPI (A.K.A Swagger) specification UI for set of paths to api entrypoints defined in given file.
Usage:
python3 -m clyjin api -f {path/to/file/with/api/paths.txt}
Structure of paths.txt might be something like:
/home/user/project1/api/main.yml
/home/user/project2/api/main.yml
/home/user/project3/api/main.yml
All paths defined in paths.txt are fetched, and if they hold correct OpenAPI
yaml spec, UI representation is built.
It is mandatory for now for API entrypoint to hold info.title info inside
according entrypoint spec. This is required to build route to this file.
For example, main.yml:
openapi: '3.0.2'
info:
title: MyProject
version: package
...
will produce OpenAPI specification on route /myproject (or any cased route,
e.g. /MyPrOjEcT since lower casing is performed before api names matching).
⚠️ WARNING
Accessing raw yaml files for main entrypoint and related dependencies is allowed across all filesystem of web-server's host (of course, where user launched the web-server has an access). Although, the validation for having exactly this api specified inpaths.txtis done, this is not the best practice to have, because validation is checking and "pinging" requested target file.
Use on your own risk in public-faced servers.
Important notes
-
Unfortunately, folder structure inside directory with entrypoint specified is not allowed. This won't pass validation for referenced yaml files. I plan to fix this in future releases
-
And yes, only yaml formats supported for now
modules.Boot
[IN DEVELOPMENT] Flexible system configurations from apps installation to own settings applying.
1 maintainer
Metadata
1 maintainer
Release files for clyjin 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| clyjin-0.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Release files / clyjin-0.1.3-py3-none-any.whl
| Download URL | clyjin-0.1.3-py3-none-any.whl |
|---|---|
| Size | 2.8 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4f998574f0462b9d7b9c323fd0e4acf865c265c666270c3e33a649708d722921
|
|
BLAKE2b-256 checksum How to use checksums |
d59af930ae660ac46ec86f3371c2ee4f89c930c3f29c8cd5f6e89900e3ae51b4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.8.10
|
