sponsored-ads-service 3.0.3rc1

S4F service responsible for sponsored ads

Sponsored Ads Service

Getting Started

Getting started with developing on sponsored-ads-service

Viewing Documentation

To view the full documentation of the project, make sure you pull the repo and run the following:

pip install -e .[docs]
mkdocs serve

Note: If you get errors when starting mkdocs, ensure that you have the client installed:

pip install -e ./client

The docs will be hosted locally on port 8000 (http://localhost:8000/)

Project Setup

These steps will go through how to set up your developer environment

Setup your virtual environment

You will have 2 choices here depending on whether you use virtualenv or pyenv-virtualenv

1. Using virtualenv:

   virtualenv -p python3 venv
   source venv/bin/activate
   

2. Using pyenv-virtualenv:

   pyenv virtualenv 3.12 sponsored-ads-service
   echo "sponsored-ads-service" >| .python-version
   

Install dependencies

Install the service and developer dependencies, as well as, configure pre-commit

pip install -e .
pip install -e .[dev]
pre-commit install

Note: If you are using zsh you may need to either:

1. Add unsetopt nomatch to your ~/.zshrc
2. Use pip install -e .\[dev\] instead

Note: If you want to run the pre-commits without committing to a branch:

pre-commit run

Build Client Locally

pip install -e ./client

Kubernetes Quickstart (Local)

Starting up a developer patched sponsored-ads-service in your local environment.

Note: Before you begin, you must have completed the steps from the Project Setup section.

helm install -n sponsored-ads-service --set dev.patch=true,dev.hostPath=$PWD charts/sponsored-ads-service