Report generate platform
Typeris great for creating CLI applications.Richmakes it easy to add beautiful formatting in the terminal.Pydantic– data validation and settings management using Python type hinting.Logurumakes logging (stupidly) simple.tqdm– fast, extensible progress bar for Python and CLI.IceCreamis a little library for sweet and creamy debugging.orjson– ultra fast JSON parsing library.Returnsmakes you function's output meaningful, typed, and safe!Hydrais a framework for elegantly configuring complex applications.FastAPIis a type-driven asynchronous web framework.
- Initialize
gitinside your repo:
cd rgp && git init- If you don't have
Poetry.
Conda environment is is recommended.
conda create -n rgp python==3.10Please activate python of current project and install run:
conda activate rgp
pip install poetry- Initialize poetry and
pre-commithooks:
make installIf you obtain a timeout error when installing, you can try to append an image source config in poetry.toml. The following example is tsinghua image source.
[[tool.poetry.source]]
name = "tsinghua"
url = "https://pypi.tuna.tsinghua.edu.cn/simple"
priority = "default"- Run the codestyle to polish your code:
make polish-codestyleConda package manager is recommended. Create a conda environment.
conda create -n rgp python==3.10<
8000
/pre>Activate conda environment and install poetry
conda activate rgp
pip install poetryThen you can run the client using the following command:
rgp --helpor with Poetry:
poetry run rgp --helpMakefile contains a lot of functions for faster development.
Install all dependencies and pre-commit hooks
Install requirements:
make installPre-commit hooks coulb be installed after git init via
make pre-commit-installCodestyle and type checks
Automatic formatting uses ruff.
make polish-codestyle
# or use synonym
make formattingCodestyle checks only, without rewriting files:
make check-codestyleNote:
check-codestyleusesruffanddarglintlibrary
Code security
If this command is not selected during installation, it cannnot be used.
make check-safetyThis command launches Poetry integrity checks as well as identifies security issues with Safety and Bandit.
make check-safetyTests with coverage badges
Run pytest
make testAll linters
Of course there is a command to run all linters in one:
make lintthe same as:
make check-codestyle && make test && make check-safetyDocker
make docker-buildwhich is equivalent to:
make docker-build VERSION=latestRemove docker image with
make docker-removeMore information about docker.
Cleanup
Delete pycache files
make pycache-removeRemove package build
make build-removeDelete .DS_STORE files
make dsstore-removeRemove .mypycache
make mypycache-removeOr to remove all above run:
make cleanupThis project is licensed under the terms of the MIT license. See LICENSE for more details.
@misc{rgp,
author = {rgp},
title = {Report generate platform},
year = {2024},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/rgp/rgp}}
}
This project was generated with P3G