Package: quantready
quantreadyA CLI to quickly launch data-driven and API-first businesses - using the modern python stack✅✅✅ QuantReady Stack - Templates ✨quantreadyCLI for creating and configuring projects and using the quantready-* templatesquantready-basebuild and publish python libraries and docker images✔️poetryfor dependency management✔️pre-commithooks for code formatting, linting, and testing✔️unittestfor testing✔️gitleaksfor secrets scanning✔️github actionsfor CI/CD✔️dockerfor building containers✔️twinefor publishing to pypi or private repositories🔲gcloudfor publishing to private repositoriesquantready-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 quantreadyquantready-vendor- A template to sell and meter access to your APIs. Supports time-based and usage-based pricingsupports 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📦 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<your-repo>

pipinstalltyper
pythonconfigure.py💻 DevelopmentInstall dependenciesRequires poetry and python3.10 or higherInstall Poetry fromhttps://github.com/python-poetry/install.python-poetry.org#python-poetry-installercurl-sSLhttps://install.python-poetry.org|python3-# Create a virtual environmentpython3-mvenvvenvsourcevenv/bin/activate# Install dependenciespoetryinstall# Install pre-commit hookspoetryrunpre-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 creation of a new releaseConfigurationSet a GitHub Repository SecretPYPI_API_TOKENequal to an API key generated from your PYPI account:Generate Token here:https://pypi.org/manage/account/token/Set it as a Repository Secret here:https://github.com///settings/secrets/actionsCreate a new ReleaseGotohttps://github.com/closedloop-technologies/quantready/releases/neworGotohttps://github.com///releasesClick "Draft a new Release"This will trigger the GitHub Action to deploy your new release to PyPiPush Docker image# Build the imagedockerbuild-tquantready/quantready.# Run the imagedockerrun-it--rmquantready/quantready# Push the image to docker hubdockerpushquantready/quantready# Push the image to gcrdockertagquantready/quantreadygcr.io/<your-project>/quantreadyPublish 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