Package: quantready-base
quantready-basePublish public or private python libraries - using the modern python stack✨ FeaturesClean Code:✔️poetryfor dependency management✔️pre-commithooks for code formatting, linting, and testing✔️unittestfor testing✔️gitleaksfor secrets scanningDeployment:✔️github actionsfor CI/CD✔️dockerfor building containers✔️twinefor publishing to pypi or private repositories🔲gcloudfor publishing to private repositories📦 InstallationThere are two ways to install:1. Install usingquantreadycliIt is best to install as a template usingghpipinstallquantready# Create a new repoquantreadycreate<your-repo>--templatequantready/quantready-base2. Install as a templateTo install and configure yourself usingghghtemplatecopyquantready/quantready-base<your-repo>

pipinstalltyper
pythonconfigure.py💻 DevelopmentInstall dependencies# Create a virtual environmentpython3-mvenvvenvsourcevenv/bin/activate# Install dependenciespoetryinstall# Install pre-commit hookspre-commitinstall--install-hooks# Create a .env file and modify it's contentscp.env.example.env🚀 DeploymentThe best way is to use quantready cli# Configure the project and cloud providersquantreadyconfigureThis will create a .quantready file in the root of the project.GitHub Actions: On push tomainGithub actions are configured to run on push to main.
It will read the config from .quantready file and
publish the library to pypi or private repository as well as build the docker image and push it to docker hub or gcr.Push Docker image# Build the imagedockerbuild-tquantready/quantready-base.# Run the imagedockerrun-it--rmquantready/quantready-base# Push the image to docker hubdockerpushquantready/quantready-base# Push the image to gcrdockertagquantready/quantready-basegcr.io/<your-project>/quantready-basePublish to pypi# Build the packagepoetrybuild
poetryruntwineuploaddist/*GetPYPI_API_TOKENfromhttps://pypi.org/manage/account/token/And set it as a github secrethttps://github.com///settings/secrets/actionsPublish to private repository# Build the packagepoetrybuild
poetryruntwineupload--repository-urlhttps://pypi.yourdomain.comdist/*📝 LicenseThis project is licensed under the terms of theMIT license.📚 ResourcesPython Packaging User GuidePoetryPre-commitGithub ActionsDockerTwineGcloudGitHub CLI✅✅✅ QuantReady Stack - TemplatesquantreadyCLI for creating and configuring projects and using the quantready-* templatesquantready-baseThis template - build and publish python libraries and docker imagesquantready-api- A template to build and deploy fastapi applicationsauthentication - api key or oauthauthorization - RBAC via OSOrate limiting - via redisjob-queues to support long-running tasksworkerscachinggithub actions to deploy to gcloudall other features of quantready-basequantready-vendor- A template to sell and meter access to your APIs. Supports time-based and usage-based pricing.supports free and paid endpointsbilling per API call or per time-periodstripe-cli integration for managing products and billingpricing-tables, account management and checkoutusage tracking apiall other features of quantready-api[quantready-chat]A template to build and deploy chatbotsSupports WebsocketsSlack Integrationall other features of quantready-vendor